forest_liana 2.9.2 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aec5c04b564d1ea85d2af7b7e097a27148996842
-  data.tar.gz: 012fff66c5d6457601ba654b6eff4e4d07652022
+  metadata.gz: b0a1f4647f0e31bc9e84c3ded9ba550c9b3d7fd7
+  data.tar.gz: 0aa2dadfd408b34049411e9945943e127a5b9b8e
 SHA512:
-  metadata.gz: 19218a4d18faff38146343fae86be93737b8c6caf716f779b7772b1c6030a101aebe82b29b5029f65600854f75c356fbdc0d48e223bb5dfce790d2057e3f559a
-  data.tar.gz: 5b296b887174352eeb49857b1e6c8f34789d4f951e12d9370616417e79d7df21ec2487fd7301c8d12d079f2fdc58a958eeaa5d35964d752361f5c58abb9f260a
+  metadata.gz: fb35fc0d3851ebedf7ebb37739847a09dc6352e3be6b62da28dcda3ca4f758db88795dc98d4a87c0c2b6b66ab0620f5fffcc3b0d3776e3db4d1944cb7b067b2d
+  data.tar.gz: e79eebb6fdecb583d82f4cdc7326845ca0a958ba6044b159fcf5336c5747c0f16ccea010bc700b4e295638fee4a6b458a76198af256ae9273aad4ba009ca7afe

data/app/controllers/forest_liana/mixpanel_controller.rb

@@ -0,0 +1,27 @@
+module ForestLiana
+  class MixpanelController < ForestLiana::ApplicationController
+    def last_events
+      collection_name = params[:collection]
+      mapping = ForestLiana.integrations[:mixpanel][:mapping]
+      mapping_for_current_collection = mapping.find { |item| item.start_with?(collection_name) }
+      field_name = mapping_for_current_collection.split('.')[1]
+      id = params[:id]
+      field_value = collection_name.constantize.find_by('id': id)[field_name]
+
+      getter = ForestLiana::MixpanelLastEventsGetter.new(params)
+      getter.perform(field_name, field_value)
+
+      custom_properties = ForestLiana.integrations[:mixpanel][:custom_properties]
+      MixpanelEventSerializer.attributes(*custom_properties)
+
+      render serializer: nil, json: serialize_models(getter.records, {
+        context: { type: get_serializer_type('mixpanel_events') },
+        count: getter.count,
+      })
+    end
+
+    def get_serializer_type(suffix)
+      "#{params[:collection]}_#{suffix}"
+    end
+  end
+end

data/app/serializers/forest_liana/mixpanel_event_serializer.rb

@@ -0,0 +1,24 @@
+module ForestLiana
+  class MixpanelEventSerializer
+    include JSONAPI::Serializer
+
+    attribute :id
+    attribute :event
+    attribute :city
+    attribute :region
+    attribute :timezone
+    attribute :os
+    attribute :osVersion
+    attribute :country
+    attribute :date
+    attribute :browser
+
+    def self_link
+      nil
+    end
+
+    def type
+      @options[:context][:type] || 'mixpanel_events'
+    end
+  end
+end

data/app/serializers/forest_liana/serializer_factory.rb

@@ -41,6 +41,8 @@ module ForestLiana
         "ForestLiana::ActionSerializer"
       elsif active_record_class == ForestLiana::Model::Segment
         "ForestLiana::SegmentSerializer"
+      elsif active_record_class == ForestLiana::MixpanelEvent
+        "ForestLiana::MixpanelEventSerializer"
       else
         serializer_name = self.build_serializer_name(active_record_class)
         "ForestLiana::UserSpace::#{serializer_name}"
@@ -109,6 +111,13 @@ module ForestLiana
             end
           end
 
+          if mixpanel_integration?
+            case attribute_name
+            when :mixpanel_last_events
+              ret[:href] = "/forest/#{ForestLiana.name_for(object.class)}/#{object.id}/mixpanel_last_events"
+            end
+          end
+
           if ret[:href].blank?
             begin
               if @options[:include].try(:include?, attribute_name.to_s)
@@ -151,6 +160,21 @@ module ForestLiana
             false
           end
         end
+
+        def mixpanel_integration?
+          mapping = ForestLiana.integrations
+            .try(:[], :mixpanel)
+            .try(:[], :mapping)
+
+          if mapping
+            collection_names = mapping.map do |collection_name_and_field|
+              collection_name_and_field.split('.')[0]
+            end
+            collection_names.include?(object.class.name)
+          else
+            false
+          end
+        end
       }
 
       unless @is_smart_collection
@@ -248,6 +272,11 @@ module ForestLiana
         serializer.send(:has_many, :stripe_bank_accounts) { }
       end
 
+      # Mixpanel
+      if has_mixpanel_integration?(active_record_class.name)
+        serializer.send(:has_many, :mixpanel_last_events) { }
+      end
+
       ForestLiana::SerializerFactory.define_serializer(active_record_class,
                                                        serializer)
 
@@ -287,6 +316,21 @@ module ForestLiana
       end
     end
 
+    def has_mixpanel_integration?(collection_name)
+      mapping = ForestLiana.integrations
+        .try(:[], :mixpanel)
+        .try(:[], :mapping)
+
+      if mapping
+        collection_names = mapping.map do |collection_name_and_field|
+          collection_name_and_field.split('.')[0]
+        end
+        collection_names.include?(collection_name)
+      else
+        false
+      end
+    end
+
     def serializer_association(association)
       case association.macro
       when :has_one, :belongs_to

data/app/services/forest_liana/mixpanel_last_events_getter.rb

@@ -0,0 +1,87 @@
+module ForestLiana
+  class MixpanelLastEventsGetter < IntegrationBaseGetter
+    attr_accessor :record
+
+    def initialize(params)
+      @params = params
+      api_secret = ForestLiana.integrations[:mixpanel][:api_secret]
+      @custom_properties = ForestLiana.integrations[:mixpanel][:custom_properties]
+      @mixpanel = Mixpanel::Client.new(api_secret: api_secret)
+    end
+
+    def perform(field_name, field_value)
+      result = @mixpanel.request(
+        'jql',
+        script: "function main() {
+          return People().filter(function (user) {
+            return user.properties.$email == '#{field_value}';
+          });
+        }"
+      )
+
+      if result.length == 0
+        @records = []
+        return
+      end
+
+      from_date = (DateTime.now << 6).strftime("%Y-%m-%d")
+      to_date = DateTime.now.strftime("%Y-%m-%d")
+      distinct_id = result[0]['distinct_id']
+
+      result = @mixpanel.request(
+        'stream/query',
+        from_date: from_date,
+        to_date: to_date,
+        distinct_ids: [distinct_id],
+        limit: 100
+      )
+
+      if result['status'] != 'ok'
+        FOREST_LOGGER.error "Cannot retrieve the Mixpanel last events"
+        @records = []
+        return
+      end
+
+      if result.length == 0
+        @records = []
+        return
+      end
+
+      @records = process_result(result['results']['events'])
+    end
+
+    def process_result(events)
+      events.reverse.map { |event|
+        properties = event['properties']
+
+        new_event = {
+          'id' => SecureRandom.uuid,
+          'event' => event['event'],
+          'city' => properties['$city'],
+          'region' => properties['$region'],
+          'timezone' => properties['$timezone'],
+          'os' => properties['$os'],
+          'osVersion' => properties['$os_version'],
+          'country' => properties['mp_country_code'],
+          'browser' => properties['browser'],
+        }
+
+        time = properties['time'].to_s
+        new_event['date'] = DateTime.strptime(time,'%s').strftime("%Y-%m-%dT%H:%M:%S%z")
+
+        custom_attributes = event['properties'].select { |key, _| @custom_properties.include? key }
+        new_event = new_event.merge(custom_attributes)
+
+        ForestLiana::MixpanelEvent.new(new_event)
+      }
+    end
+
+    def records
+      @records
+    end
+
+    def count
+      @records.count
+    end
+  end
+end

data/app/services/forest_liana/schema_adapter.rb

@@ -179,6 +179,28 @@ module ForestLiana
         end
       end
 
+      # NOTICE: Add Mixpanel field
+      mixpanel_mapping = ForestLiana.integrations
+        .try(:[], :mixpanel)
+        .try(:[], :mapping)
+
+      if mixpanel_mapping && mixpanel_mapping
+          .select { |mapping| mapping.split('.')[0] == @model.name }
+          .size > 0
+
+        model_name = ForestLiana.name_for(@model)
+
+        collection.fields << {
+          field: :mixpanel_last_events,
+          type: ['String'],
+          reference: "#{model_name}_mixpanel_events.id",
+          column: nil,
+          'is-filterable': false,
+          'display-name': 'Last events',
+          integration: 'mixpanel',
+        }
+      end
+
       # NOTICE: Add Paperclip url attributes
       if @model.respond_to?(:attachment_definitions)
         @model.attachment_definitions.each do |key, value|

data/config/routes.rb

@@ -39,6 +39,9 @@ ForestLiana::Engine.routes.draw do
   get ':collection/:id/intercom_attributes' => 'intercom#attributes'
   get '(*collection)_intercom_conversations/:conversation_id' => 'intercom#conversation'
 
+  # Mixpanel Integration
+  get ':collection/:id/mixpanel_last_events' => 'mixpanel#last_events'
+
   # Devise support
   post '/actions/change-password' => 'devise#change_password'
 

data/lib/forest_liana.rb

@@ -4,6 +4,9 @@ module Forest
 end
 
 module ForestLiana
+
+  autoload :MixpanelEvent, 'forest_liana/mixpanel_event'
+
   module UserSpace
   end
 

data/lib/forest_liana/bootstraper.rb

@@ -113,6 +113,17 @@ module ForestLiana
             'Please go to https://doc.forestadmin.com for more information.'
         end
       end
+
+      if mixpanel_integration?
+        if mixpanel_integration_valid?
+          ForestLiana.integrations[:mixpanel][:mapping] =
+            cast_to_array(ForestLiana.integrations[:mixpanel][:mapping])
+          @integration_mixpanel_valid = true
+        else
+          FOREST_LOGGER.error 'Cannot setup properly your Mixpanel integration. ' \
+            'Please go to https://doc.forestadmin.com for more information.'
+        end
+      end
     end
 
     def namespace_duplicated_models
@@ -149,6 +160,12 @@ module ForestLiana
           setup_intercom_integration collection_name
         end
       end
+
+      if @integration_mixpanel_valid
+        ForestLiana.integrations[:mixpanel][:mapping].each do |collection_name|
+          setup_mixpanel_integration collection_name
+        end
+      end
     end
 
     def require_lib_forest_liana
@@ -522,6 +539,61 @@ module ForestLiana
       is_deprecated
     end
 
+    def setup_mixpanel_integration(collection_name_and_field)
+      collection_name = collection_name_and_field.split('.')[0]
+      model_name = ForestLiana.name_for(collection_name.constantize)
+      collection_display_name = model_name.capitalize
+
+      field_attributes = { 'is-filterable': false , 'is-virtual': true, 'is-sortable': false }
+
+      fields = [
+        { field: :id, type: 'String' },
+        { field: :event, type: 'String' },
+        { field: :date, type: 'Date' },
+        { field: :city, type: 'String' },
+        { field: :region, type: 'String' },
+        { field: :country, type: 'String' },
+        { field: :timezone, type: 'String' },
+        { field: :os, type: 'String' },
+        { field: :osVersion, type: 'String' },
+        { field: :browser, type: 'String' },
+        { field: :browserVersion, type: 'String' },
+      ]
+
+      fields = fields.map { |field| field.merge(field_attributes) }
+
+      custom_properties = ForestLiana.integrations[:mixpanel][:custom_properties]
+      custom_properties = custom_properties.map { |property|
+        { field: property.to_sym, type: 'String' }.merge(field_attributes)
+      }
+
+      fields = fields.concat(custom_properties)
+
+      ForestLiana.apimap << ForestLiana::Model::Collection.new({
+        name: "#{model_name}_mixpanel_events",
+        display_name: "#{collection_display_name} Events",
+        icon: 'mixpanel',
+        integration: 'mixpanel',
+        is_virtual: true,
+        is_read_only: true,
+        only_for_relationships: true,
+        pagination_type: 'cursor',
+        fields: fields
+      })
+    end
+
+    def mixpanel_integration?
+      ForestLiana.integrations
+        .try(:[], :mixpanel)
+        .present?
+    end
+
+    def mixpanel_integration_valid?
+      integration = ForestLiana.integrations.try(:[], :mixpanel)
+      integration.present? && integration.has_key?(:api_secret) &&
+      integration.has_key?(:mapping)
+    end
+
     def forest_url
       ENV['FOREST_URL'] || 'https://api.forestadmin.com';
     end

data/lib/forest_liana/mixpanel_event.rb

@@ -0,0 +1,4 @@
+module ForestLiana
+  class MixpanelEvent < OpenStruct
+  end
+end

data/lib/forest_liana/version.rb

@@ -1,3 +1,3 @@
 module ForestLiana
-  VERSION = "2.9.2"
+  VERSION = "2.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 2.9.2
+  version: 2.10.0
 platform: ruby
 authors:
 - Sandro Munda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -144,6 +144,7 @@ files:
 - app/controllers/forest_liana/base_controller.rb
 - app/controllers/forest_liana/devise_controller.rb
 - app/controllers/forest_liana/intercom_controller.rb
+- app/controllers/forest_liana/mixpanel_controller.rb
 - app/controllers/forest_liana/resources_controller.rb
 - app/controllers/forest_liana/router.rb
 - app/controllers/forest_liana/sessions_controller.rb
@@ -161,6 +162,7 @@ files:
 - app/serializers/forest_liana/collection_serializer.rb
 - app/serializers/forest_liana/intercom_attribute_serializer.rb
 - app/serializers/forest_liana/intercom_conversation_serializer.rb
+- app/serializers/forest_liana/mixpanel_event_serializer.rb
 - app/serializers/forest_liana/segment_serializer.rb
 - app/serializers/forest_liana/serializer_factory.rb
 - app/serializers/forest_liana/session_serializer.rb
@@ -186,6 +188,7 @@ files:
 - app/services/forest_liana/intercom_conversations_getter.rb
 - app/services/forest_liana/line_stat_getter.rb
 - app/services/forest_liana/live_query_checker.rb
+- app/services/forest_liana/mixpanel_last_events_getter.rb
 - app/services/forest_liana/operator_date_interval_parser.rb
 - app/services/forest_liana/operator_value_parser.rb
 - app/services/forest_liana/permissions_checker.rb
@@ -223,6 +226,7 @@ files:
 - lib/forest_liana/bootstraper.rb
 - lib/forest_liana/collection.rb
 - lib/forest_liana/engine.rb
+- lib/forest_liana/mixpanel_event.rb
 - lib/forest_liana/version.rb
 - lib/generators/forest_liana/install_generator.rb
 - test/dummy/README.rdoc
@@ -291,8 +295,6 @@ files:
 - test/dummy/db/migrate/20160628173505_add_timestamps.rb
 - test/dummy/db/migrate/20170614141921_create_serialize_field.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -391,7 +393,6 @@ test_files:
 - test/dummy/public/500.html
 - test/dummy/public/404.html
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
 - test/dummy/db/migrate/20150608133038_create_belongs_to_field.rb
 - test/dummy/db/migrate/20150608130516_create_date_field.rb
 - test/dummy/db/migrate/20160627172951_create_tree.rb
@@ -410,7 +411,6 @@ test_files:
 - test/dummy/db/migrate/20150608131603_create_decimal_field.rb
 - test/dummy/db/migrate/20150623115554_create_has_many_class_name_field.rb
 - test/dummy/db/migrate/20150616150629_create_polymorphic_field.rb
-- test/dummy/log/test.log
 - test/dummy/README.rdoc
 - test/integration/navigation_test.rb
 - test/forest_liana_test.rb