itly-plugin-amplitude 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d14dad1deaee5525bf9d21dab3f2f661682b4d11f448859511756a2df96962b1
+  data.tar.gz: f8eb63bf513f4b5c9ab24973ff3d5ebea47a10b1dfef5c717152cfbac608d2a2
+SHA512:
+  metadata.gz: 356c30953cc309af7d7ccdbaf43674a67632c2a4aab262ce91e875bf228903520535da0e6fc0c72cdcc710de3c4b98fe0b004fd46e4111ddd884dcaa3d2bf59d
+  data.tar.gz: 5e9e0f3682c07c384b7bc6422e263765d90ab0185263336a61ac84dddcc85883118df3c1f8ebd747d5a912241201e58360d81d88746887cade2c678900c8fd3a

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in itly-plugin-amplitude.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+if ENV['LOCAL_ITLY_GEM']
+  # TODO: before publication to RubyGems, switch to version 1
+  gem 'itly-sdk', '~> 0.1', path: '../sdk'
+end
+
+gem 'rbs', '~> 1.0'
+gem 'rspec'
+gem 'steep', '~> 0.41'

data/Steepfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+
+  library 'logger', 'set', 'itly-sdk'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'itly/plugin-amplitude'
+
+# 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/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Configure and load RBS
+unless ENV['DISABLE_TYPE_CHECKING']
+  ENV['RBS_TEST_TARGET'] = 'Itly::*'
+  ENV['RBS_TEST_LOGLEVEL'] = 'warn'
+  ENV['RBS_TEST_DOUBLE_SUITE'] = 'rspec'
+  ENV['RBS_TEST_OPT'] = '-I./sig -I../sdk/sig'
+
+  require 'rbs/test/setup'
+end
+
+# Start RSpec
+require 'rspec/core'
+
+ENV['RSPEC_RUN_FROM_SCRIPT'] = 'true'
+RSpec::Core::Runner.invoke

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/itly-plugin-amplitude.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/itly/plugin/amplitude/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'itly-plugin-amplitude'
+  spec.version       = Itly::Plugin::Amplitude::VERSION
+  spec.authors       = ['Iteratively', 'Benjamin Bouchet', 'Justin Fiedler', 'Andrey Sokolov']
+  spec.email         = ['support@iterative.ly']
+
+  spec.summary       = 'Amplitude plugin for Iteratively SDK for Ruby'
+  spec.description   = 'Track and validate analytics with a unified, extensible interface ' \
+                       'that works with all your 3rd party analytics providers.'
+  spec.homepage      = 'https://github.com/iterativelyhq/itly-sdk-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/iterativelyhq/itly-sdk-ruby/plugin-amplitude'
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'amplitude-api', '~> 0.3'
+  spec.add_dependency 'itly-sdk', '~> 0.1'
+end

data/lib/itly/plugin-amplitude.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+if ENV['LOCAL_ITLY_GEM']
+  lib = File.expand_path('../../../sdk/lib', File.dirname(__FILE__))
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+
+require_relative 'plugin/amplitude/amplitude'
+require_relative 'plugin/amplitude/options'
+require_relative 'plugin/amplitude/call_options'
+require_relative 'plugin/amplitude/version'

data/lib/itly/plugin/amplitude/amplitude.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+require 'amplitude-api'
+
+class Itly
+  class Plugin
+    ##
+    # Amplitude plugin class for Itly SDK
+    #
+    class Amplitude < Plugin
+      attr_reader :logger, :disabled
+
+      ##
+      # Instantiate a new Plugin::Amplitude
+      #
+      # @param [String] api_key: specify the Amplitude api key
+      # @param [TrueClass/FalseClass] disabled: set to true to disable the plugin. Default to false
+      #
+      def initialize(api_key:, disabled: false)
+        super()
+        @disabled = disabled
+
+        ::AmplitudeAPI.config.api_key = api_key
+      end
+
+      ##
+      # Initialize AmplitudeApi client
+      #
+      # @param [Itly::PluginOptions] options: plugins options
+      #
+      def load(options:)
+        super
+        # Get options
+        @logger = options.logger
+
+        # Log
+        logger&.info "#{id}: load()"
+
+        logger&.info "#{id}: plugin is disabled!" if @disabled
+      end
+
+      ##
+      # Identify a user
+      #
+      # Raise an error if the response is not 200
+      #
+      # @param [String] user_id: the id of the user in your application
+      # @param [Hash] properties: the properties containing user's traits to pass to your application
+      # @param [Itly::Plugin::Amplitude::IdentifyOptions] options: the plugin specific options
+      #
+      def identify(user_id:, properties: nil, options: nil)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log user_id: user_id, properties: properties, options: options
+        logger&.info "#{id}: identify(#{log})"
+
+        # Send through the client
+        payload = {}
+        payload.merge! options.to_hash if options
+        payload.merge! properties if properties
+
+        call_end_point(options&.callback) do
+          ::AmplitudeAPI.send_identify user_id, nil, payload
+        end
+      end
+
+      ##
+      # Track an event
+      #
+      # Raise an error if the response is not 200
+      #
+      # @param [String] user_id: the id of the user in your application
+      # @param [Event] event: the Event object to pass to your application
+      # @param [Itly::Plugin::Amplitude::TrackOptions] options: the plugin specific options
+      #
+      def track(user_id:, event:, options: nil)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log(
+          user_id: user_id, event: event&.name, properties: event&.properties, options: options
+        )
+        logger&.info "#{id}: track(#{log})"
+
+        # Send through the client
+        call_end_point(options&.callback) do
+          ::AmplitudeAPI.track ::AmplitudeAPI::Event.new(
+            user_id: user_id,
+            event_type: event.name,
+            event_properties: event.properties,
+            **(options&.to_hash || {})
+          )
+        end
+      end
+
+      ##
+      # Get the plugin ID
+      #
+      # @return [String] plugin id
+      #
+      def id
+        'amplitude'
+      end
+
+      private
+
+      def enabled?
+        !@disabled
+      end
+
+      def call_end_point(callback)
+        raise 'You need to give a block' unless block_given?
+
+        # Call remote endpoint (Note: the AmplitudeAPI is using Faraday)
+        response = yield
+
+        # yield to the callback passed in to options
+        callback&.call(response.status, response.body)
+
+        # Return in case of success
+        return if response.status >= 200 && response.status < 300
+
+        # Raise in case of error
+        message = "The remote end-point returned an error. Response status: #{response.status}. "\
+          "Raw body: #{response.body}"
+        raise Itly::RemoteError, message
+      end
+    end
+  end
+end

data/lib/itly/plugin/amplitude/call_options.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    # Amplitude plugin class for Itly SDK
+    class Amplitude
+      ##
+      # Amplitude specific plugin options class
+      #
+      class CallOptions < Itly::PluginCallOptions
+        PROPS = %w[device_id time groups app_version platform os_name os_version device_brand device_manufacturer
+                   device_model carrier country region city dma language price quantity revenue productId revenueType
+                   location_lat location_lng ip idfa idfv adid android_id event_id session_id insert_id].freeze
+
+        attr_reader :callback, *PROPS
+
+        class_eval(
+          <<-EVAL, __FILE__, __LINE__ + 1
+            def initialize(callback: nil, #{PROPS.collect { |p| "#{p}: nil" }.join ', '})  # def initialize(callback: nil, device_id: nil, ...)
+              super()                                                                      #   super()
+              @callback = callback                                                         #   @callback = callback
+              #{PROPS.collect { |p| "@#{p} = #{p}" }.join "\n"}                            #   @device_id = device_id
+            end                                                                            # end
+          EVAL
+        )
+
+        ##
+        # Return all properties to be passed to the client
+        # While excluding the `callback` property
+        #
+        # @return [Hash] properties
+        #
+        def to_hash
+          PROPS.each_with_object({}) { |prop, hash| hash[prop.to_sym] = send(prop) unless send(prop).nil? }
+        end
+
+        ##
+        # Get the plugin description, for logs
+        #
+        # @return [String] description
+        #
+        def to_s
+          class_name = self.class.name.split('::').last
+          props = PROPS.collect { |prop| " #{prop}: #{send prop}" unless send(prop).nil? }.compact
+          "#<Amplitude::#{class_name} callback: #{callback.nil? ? 'nil' : 'provided'}#{props.join}>"
+        end
+      end
+
+      ##
+      # Amplitude specific plugin options class for calls to plugin methods
+      #
+      %w[Identify Group Page Track Alias].each do |name|
+        class_eval(
+          <<-EVAL, __FILE__, __LINE__ + 1
+            class #{name}Options < CallOptions         # class IdentifyOptions < CallOptions
+            end                                        # end
+          EVAL
+        )
+      end
+    end
+  end
+end

data/lib/itly/plugin/amplitude/options.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+
+class Itly
+  class Plugin
+    class Amplitude
+      ##
+      # Options for the Amplitude plugin class
+      #
+      # rubocop:disable Lint/EmptyClass
+      class Options
+      end
+      # rubocop:enable Lint/EmptyClass
+    end
+  end
+end

data/lib/itly/plugin/amplitude/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    class Amplitude < Plugin
+      VERSION = '0.1.0'
+    end
+  end
+end

data/sig/amplitude.rbs

@@ -0,0 +1,21 @@
+class Itly
+  class Plugin
+    class Amplitude < Plugin
+      VERSION: String
+
+      attr_reader logger: Logger?
+      attr_reader disabled: bool
+
+      def load: (options: Itly::PluginOptions options) -> void
+      def identify: (user_id: String user_id, ?properties: propertiesHash?, ?options: Itly::Plugin::Amplitude::IdentifyOptions? options) -> void
+      def track: (user_id: String user_id, event: Itly::Event event, ?options: Itly::Plugin::Amplitude::TrackOptions? options) -> void
+      def id: () -> String
+
+      private
+
+      def initialize: (api_key: String api_key, ?disabled: bool disabled) -> void
+      def enabled?: () -> bool
+      def call_end_point: ((^(Integer?, String?) -> void)? callback) ?{ () -> Faraday::Response } -> void
+    end
+  end
+end

data/sig/call_options.rbs

@@ -0,0 +1,31 @@
+class Itly
+  class Plugin
+    class Amplitude
+      class CallOptions < Itly::PluginCallOptions
+        attr_reader callback: (^(Integer?, String?) -> void)?
+
+        def to_hash: () -> Hash[Symbol, String | Integer | Float | untypedHash]
+        def to_s: () -> String
+
+        private
+
+        def initialize: (?callback: (^(Integer?, String?) -> void)? callback, ?device_id: String? device_id, ?time: Integer? time, ?groups: untypedHash? groups, ?app_version: String? app_version, ?platform: String? platform, ?os_name: String? os_name, ?os_version: String? os_version, ?device_brand: String? device_brand, ?device_manufacturer: String? device_manufacturer, ?device_model: String? device_model, ?carrier: String? carrier, ?country: String? country, ?region: String? region, ?city: String? city, ?dma: String? dma, ?language: String? language, ?price: Float? price, ?quantity: Integer? quantity, ?revenue: Float? revenue, ?productId: String? productId, ?revenueType: String? revenueType, ?location_lat: Float? location_lat, ?location_lng: Float? location_lng, ?ip: String? ip, ?idfa: String? idfa, ?idfv: String? idfv, ?adid: String? adid, ?android_id: String? android_id, ?event_id: Integer? event_id, ?session_id: Integer? session_id, ?insert_id: String? insert_id) -> void
+      end
+
+      class IdentifyOptions < CallOptions
+      end
+
+      class GroupOptions < CallOptions
+      end
+
+      class PageOptions < CallOptions
+      end
+
+      class TrackOptions < CallOptions
+      end
+
+      class AliasOptions < CallOptions
+      end
+    end
+  end
+end

data/sig/lib/faraday_response.rbs

@@ -0,0 +1,7 @@
+# Part of the gems
+class Faraday
+  class Response
+    attr_reader status: Integer?
+    attr_reader body: String
+  end
+end

data/sig/lib/monitor_mixin.rbs

@@ -0,0 +1,3 @@
+# Part of the gems
+class MonitorMixin
+end

data/sig/options.rbs

@@ -0,0 +1,8 @@
+class Itly
+  class Plugin
+    class Amplitude
+      class Options
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: itly-plugin-amplitude
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Iteratively
+- Benjamin Bouchet
+- Justin Fiedler
+- Andrey Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amplitude-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: itly-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Track and validate analytics with a unified, extensible interface that
+  works with all your 3rd party analytics providers.
+email:
+- support@iterative.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Steepfile
+- bin/console
+- bin/rspec
+- bin/setup
+- itly-plugin-amplitude.gemspec
+- lib/itly/plugin-amplitude.rb
+- lib/itly/plugin/amplitude/amplitude.rb
+- lib/itly/plugin/amplitude/call_options.rb
+- lib/itly/plugin/amplitude/options.rb
+- lib/itly/plugin/amplitude/version.rb
+- sig/amplitude.rbs
+- sig/call_options.rbs
+- sig/lib/faraday_response.rbs
+- sig/lib/monitor_mixin.rbs
+- sig/options.rbs
+homepage: https://github.com/iterativelyhq/itly-sdk-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/iterativelyhq/itly-sdk-ruby
+  source_code_uri: https://github.com/iterativelyhq/itly-sdk-ruby/plugin-amplitude
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Amplitude plugin for Iteratively SDK for Ruby
+test_files: []