octocore 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0ea80f8160f1f05b3d5259a207e76f7b2c75410
-  data.tar.gz: 80624160dd4076191d70c284fcb6c25bce21f660
+  metadata.gz: 57da45f6015209dc84edccb5100950f1142874e4
+  data.tar.gz: cc6cc5ce82f388aba3d0ecc34a2aa41d6637b25a
 SHA512:
-  metadata.gz: efbe9cdda85b673d4adf8e7b4764cfe4eed2aad44e84c35a6f7a70b691ee82461994cb37ddde95fc85f3cd40f643af54d84fde4dab8e02a1232c21a83f0f3c27
-  data.tar.gz: 8116ecd4d607d55a64823920e48156a2f74dd3388121af4887d91321e82554336fa6b6f50227ef4774ba58c5e774a9fb0f4a840462a004d574e133f80d61162b
+  metadata.gz: f11d644298e9cb9cace499cd7d638fb507687b4f7420bbce09955f0b30053f27dd3645065ab14d4542ad6cf615c6a908db25535f48b8840a71227c57dce965df
+  data.tar.gz: 715fd3946f9081dabc8ad6713b85189be6e738c6f1d0e45518f1baa36ab3bffab6fa814b6054205c8a2f2841023b4a2a8017f6c4a83987b970ae3f8d6efc55dc

data/Gemfile

@@ -1,3 +1,10 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+end
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    octocore (0.0.2)
+    octocore (0.0.3)
       cequel (~> 1.9, >= 1.9.0)
       descriptive_statistics (~> 2.5.1, >= 2.5.0)
       elasticsearch (~> 1.0.17, >= 1.0.17)
@@ -82,20 +82,20 @@ GEM
       redis (~> 3.0)
       resque (~> 1.25)
       rufus-scheduler (~> 3.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    ruby-kafka (0.3.11)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby-kafka (0.3.12)
     rufus-scheduler (3.2.1)
     sinatra (1.4.7)
       rack (~> 1.5)
@@ -116,4 +116,8 @@ PLATFORMS
 DEPENDENCIES
   octocore!
   parallel_tests (~> 2.5.0, >= 2.5.0)
-  rspec (~> 3.4.0, >= 3.4.0)
+  rake
+  rspec
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,8 @@
+Octo.ai, (C) 2015,2016 Aurora Borealis Technologies Pvt. Ltd.
+
+This product includes software developed at Aurora Borealis Technologies Pvt. Ltd (https://octo.ai/).
+
+The Octoai project contains unmodified/modified subcomponents too with
+separate copyright notices and license terms. Your use of the source
+code for these subcomponents is subject to the terms and conditions
+of the following licenses.

data/README.md

@@ -2,29 +2,44 @@
 
 This is the Octomatic Enterprise Core gem. It provides most of the ORM stuff. Class and modules for different tables.
 
+## Installting
 
-**Rake Tasks**
+- `gem install octocore`
+
+
+
+## DB Migrations
+
+### OctoAdmin CLI
+
+This gem comes with a handy utility called `octocore-admin`. You can use this utility for db migrations, reset and init.
 
 ```bash
-rake cequel:keyspace:create  # Initialize Cassandra keyspace
-rake cequel:keyspace:drop    # Drop Cassandra keyspace
-rake octo:init               # Create keyspace and tables for all defined models
-rake octo:migrate            # Synchronize all models defined in `lib/octocore/models' with Cassandra database schema
-rake octo:reset              # Drop keyspace if exists, then create and migrate
-rake spec                    # Run RSpec code examples
+$ octocore-admin action path/to/config/dir
 ```
 
-# Building
+Where
+
+- `action`: The action to be performed. One of `init`, `migrate` or `reset`
+- `/path/to/config/dir`: The path where your config dir is placed
+
+
+# Development
+
+## Clone the repo
+
+`$ git clone git@github.com:octoai/gem-octocore.git`
+
+## Building
 
 ```bash
-./bin/clean_setup.sh
+$ ./bin/clean_setup.sh
 ```
 
-# Specs
+## Specs
 
-```
-lang=bash
-rake spec
+```bash
+$ rake spec
 ```
 
 # Verifying connectivity
@@ -32,9 +47,9 @@ rake spec
 You can use the following set of commands in `irb` to verify all things working with this gem. Execute it from irb in PROJ_DIR.
 
 ```ruby
-%w(octocore).each { |x| require x }
-config_file = 'lib/octocore/config/config.yml'
-Octo.connect_with_config_file(config_file)
+require 'octocore'
+config_dir = '/path/to/config/dir'
+Octo.connect_with_config_file config_dir
 ```
 
 # Creating fake stream
@@ -42,11 +57,5 @@ Octo.connect_with_config_file(config_file)
 It ships with a utility called `fakestream`. It will automatically stream random data. To use just open your console and type
 
 ```
-fakestream
-```
-
-Optionally provide a config file for octo to connect as 
-
-```
-fakestream /path/to/octo_config.yml
+$ fakestream /path/to/config/dir
 ```

data/Rakefile

@@ -9,13 +9,13 @@ require 'octocore/config'
 RSpec::Core::RakeTask.new('spec')
 
 task :environment do
-  config_dir = 'lib/octocore/config'
+  config_dir = ENV['CONFIG_DIR'] || 'lib/octocore/config/'
   config = {}
-  Dir['**{,/*/**}/*.yml'].each do |file|
+  Dir[config_dir + '**{,/*/**}/*.yml'].each do |file|
     _config = YAML.load_file(file)
     if _config
       puts "loading from file: #{ file }"
-      config.merge!(_config.deep_symbolize_keys)
+      config = config.merge(_config.deep_symbolize_keys)
     end
   end
   Octo.load_config config
@@ -36,7 +36,7 @@ end
 namespace :octo do
 
   desc 'Create keyspace and tables for all defined models'
-  task :init => %w(cequel:keyspace:create octo:migrate)
+  task :init => %w(environment cequel:keyspace:create octo:migrate)
 
   desc 'Drop keyspace if exists, then create and migrate'
   task :reset => :environment do
@@ -136,3 +136,4 @@ def migrate
     end
   end
 end
+

data/bin/octocore-admin

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+#
+# A simple utility to provide easy migrations, reset
+# and all the rake tasks that you may need to do
+
+# ./octocore-admin --tasks
+
+require 'open3'
+
+module Octo
+  module CliAdmin
+
+    VALID_ACTIONS = %w(init migrate reset)
+
+    module ClassMethods
+      def perform(action, config_dir)
+        if VALID_ACTIONS.include?(action)
+          cmd = ['rake', '-f', spec.gem_dir + '/Rakefile',
+                '--verbose', "octo:#{ action }",
+                "CONFIG_DIR=#{ config_dir }"]
+          #STDOUT.puts "** Executing: #{ cmd }"
+          Open3.popen3(*cmd) do |stdout, stderr, status, thread|
+            stderr.sync = true
+            while line=stderr.gets do
+              puts(line)
+            end
+          end
+        else
+          STDOUT.puts "Invalid action: #{ action }"
+        end
+      end
+
+      def spec
+        @spec ||= Gem::Specification.find_by_name 'octocore'
+      end
+    end
+
+    class Cli
+      extend ClassMethods
+    end
+
+    def self.main
+      STDOUT.sync = true
+      action = ARGV[0]
+      config_dir = ARGV[1]
+      Octo::CliAdmin::Cli.perform(action, config_dir)
+    end
+
+  end
+end
+
+
+Octo::CliAdmin.main
+

data/lib/octocore.rb

@@ -4,6 +4,8 @@ require 'logger'
 
 require 'octocore/version'
 require 'octocore/config'
+require 'octocore/featureflag'
+
 require 'octocore/models'
 require 'octocore/counter'
 require 'octocore/email'
@@ -19,6 +21,8 @@ require 'octocore/segment'
 require 'octocore/mailer'
 require 'octocore/scheduler'
 
+require 'octocore/message_parser'
+
 require 'octocore/schedeuleable'
 require 'octocore/helpers'
 require 'octocore/kafka_bridge'
@@ -143,4 +147,4 @@ module Octo
     @logger
   end
 
-end
+end

data/lib/octocore/callbacks.rb

@@ -70,10 +70,12 @@ module Octo
       # product_page_view to redis.
       # It self expires in n seconds from last hit
       def add_session(opts)
-        if opts.has_key?(:type)
-          createRedisShadowKey(opts[:enterprise].id.to_s + '_' + opts[:user].id.to_s,
-                               opts[:type].to_s,
-                               Octo.get_config(:session_length))
+        if Octo.is_not_flagged?(Octo::Funnel)
+          if opts.has_key?(:type)
+            createRedisShadowKey(opts[:enterprise].id.to_s + '_' + opts[:user].id.to_s,
+                                 opts[:type].to_s,
+                                 Octo.get_config(:session_length))
+          end
         end
       end
 
@@ -102,4 +104,4 @@ module Octo
     include Hooks
     include Octo::OctoHooks
   end
-end
+end

data/lib/octocore/email.rb

@@ -3,7 +3,7 @@ require 'resque'
 require 'resque-scheduler'
 
 module Octo
-  
+
   # Octo Email Sender
   module Email
 
@@ -16,7 +16,7 @@ module Octo
         raise ArgumentError, 'Email Address or Subject is missing'
       else
         message = {
-          from_name: Octo.get_config(:email_sender).fetch(:name),  
+          from_name: Octo.get_config(:email_sender).fetch(:name),
           from_email: Octo.get_config(:email_sender).fetch(:email),
 
           subject: subject,
@@ -30,7 +30,8 @@ module Octo
           }]
         }
         # Pass the message to resque only when mandrill key is present
-        if Octo.get_config(:mandrill_api_key) != ''
+        _mandrill_config = ENV['MANDRILL_API_KEY'] || Octo.get_config(:mandrill_api_key)
+        if _mandrill_config and !_mandrill_config.empty?
           enqueue_msg(message)
         end
       end
@@ -46,16 +47,17 @@ module Octo
 
   # Class to perform Resque operations for sending email
   class EmailSender
-    
+
     @queue = :email_sender
-    
+
     # Resque Perform method
     # @param [Hash] message The details of email
     def self.perform(message)
-      m = Mandrill::API.new Octo.get_config(:mandrill_api_key)
+      _mandrill_config = ENV['MANDRILL_API_KEY'] || Octo.get_config(:mandrill_api_key)
+      m = Mandrill::API.new _mandrill_config
       m.messages.send message
     end
 
   end
+end
 
-end

data/lib/octocore/featureflag.rb

@@ -0,0 +1,77 @@
+require 'set'
+
+module Octo
+
+  # The FeatureFlag Module
+  #
+  #   This module flags some functionalities as OFF or DISABLED state.
+  module FeatureFlag
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      # Set the featureflag for a module or class to the state. If the
+      #   featureflag is set to true, it means that the feature is disabled. If
+      #   the featureflag is set to false, it means that the feature is enabled.
+      #
+      #   It also defined a `is_flagged?` method on the module which returns
+      #   the state of featureflag
+      #
+      # @param [Module] klass The class or module to be feature flagged
+      # @param [Boolean] state The boolean state to set for the class
+      #
+      def featureflag(klass, state)
+        if state
+          unless flags.include?klass
+            flags << klass
+            klass.instance_eval do
+              def is_flagged?
+                true
+              end
+            end
+          end
+        else
+          if flags.include?klass
+            flags.delete(klass)
+            klass.instance_eval do
+              def is_flagged?
+                false
+              end
+            end
+          end
+        end
+      end
+
+      # Get the list of all flags
+      # @return [Set] A set of all flags
+      #
+      def flags
+        @flags ||= Set.new([])
+      end
+
+      # Helper method to find if a module is feature flagged or not
+      # @param [Module] feature The module to be tested
+      # @return [Boolean] Boolean value specifying if the feature is flagged
+      #   or not
+      #
+      def is_flagged?(feature)
+        flags.include?feature
+      end
+
+      # Returns if the flag is not set
+      # @param [Module] feature The module to be tested
+      # @return [Boolean] Boolean value specifying the status
+      #
+      def is_not_flagged?(feature)
+        !is_flagged?feature
+      end
+    end
+
+  end
+
+  include FeatureFlag
+end
+

data/lib/octocore/helpers/api_consumer_helper.rb

@@ -4,8 +4,10 @@ require 'set'
 module Octo
   module Helpers
 
+    # Helper Module for Octo Consumer
     module ApiConsumerHelper
       extend Cequel::Metal
+
       # Get all the valid events
       # @return [Set<Symbol>] Valid events globally
       def valid_events
@@ -20,95 +22,103 @@ module Octo
         Set.new(%w(app.init app.login app.logout page.view productpage.view update.profile))
       end
 
+      # Handles Kafka messages and perform required operations
+      # @param [Hash] msg Hash Message
       def handle(msg)
-          msg_dump = msg
-          msg = parse(msg)
-          eventName = msg.delete(:event_name)
-          if (valid_events.include?eventName)
-            enterprise = checkEnterprise(msg)
-            unless enterprise
-              Octo.logger.info 'Unable to find enterprise. Something\'s wrong'
-            end
-            user = checkUser(enterprise, msg)
-
-            hook_opts = {
-                enterprise: enterprise,
-                user: user
-            }
-
-            if api_events.include?eventName
-              hook_opts[:event] = register_api_event(enterprise, eventName)
-              Octo::ApiTrack.new(customid: msg[:id],
-                                 created_at: Time.now,
-                                 json_dump: msg_dump,
-                                 type: eventName).save!
-            end
+        msg_obj = Octo::Message::Message.new(msg)
+        msg = msg_obj.to_h
+        eventName = msg.delete(:event_name)
+        if (valid_events.include?eventName)
+          enterprise = checkEnterprise(msg)
+          unless enterprise
+            Octo.logger.info 'Unable to find enterprise. Something\'s wrong'
+          end
+          user = checkUser(enterprise, msg)
+
+          hook_opts = {
+              enterprise: enterprise,
+              user: user
+          }
+
+          if api_events.include?eventName
+            hook_opts[:event] = register_api_event(enterprise, eventName)
+            Octo::ApiTrack.new(customid: msg[:id],
+                               created_at: Time.now,
+                               json_dump: msg_obj.message,
+                               type: eventName).save!
+          end
 
-            case eventName
-              when 'app.init'
-                Octo::AppInit.new(enterprise: enterprise,
-                                  created_at: Time.now,
-                                  userid: user.id).save!
-                updateUserDeviceDetails(user, msg)
-                hook_opts.merge!({type: 'init'})
-                call_hooks(eventName, hook_opts)
-              when 'app.login'
-                Octo::AppLogin.new(enterprise: enterprise,
-                                   created_at: Time.now,
-                                   userid: user.id).save!
-                updateUserDeviceDetails(user, msg)
-                call_hooks(eventName, hook_opts)
-              when 'app.logout'
-                event = Octo::AppLogout.new(enterprise: enterprise,
-                                            created_at: Time.now,
-                                            userid: user.id).save!
-                updateUserDeviceDetails(user, msg)
-                call_hooks(eventName, hook_opts)
-              when 'page.view'
-                page, categories, tags = checkPage(enterprise, msg)
-                Octo::PageView.new(enterprise: enterprise,
-                                   created_at: Time.now,
-                                   userid: user.id,
-                                   routeurl: page.routeurl
-                ).save!
-                hook_opts.merge!({type: page.routeurl})
-                updateUserDeviceDetails(user, msg)
-                call_hooks(eventName, hook_opts)
-              when 'productpage.view'
-                product, categories, tags = checkProduct(enterprise, msg)
-                Octo::ProductPageView.new(
-                                         enterprise: enterprise,
-                                         created_at: Time.now,
-                                         userid: user.id,
-                                         product_id: product.id
-                ).save!
-                updateUserDeviceDetails(user, msg)
-                hook_opts.merge!({ product: product,
-                                   categories: categories,
-                                   tags: tags,
-                                   type: product.routeurl
-                                 })
-                call_hooks(eventName, hook_opts)
-              when 'update.profile'
-                checkUserProfileDetails(enterprise, user, msg)
-                updateUserDeviceDetails(user, msg)
-                call_hooks(eventName, hook_opts)
-              when 'update.push_token'
-                checkPushToken(enterprise, user, msg)
-                checkPushKey(enterprise, msg)
-              when 'funnel_update'
-                checkRedisSession(enterprise,msg)
-            end
+          case eventName
+          when 'app.init'
+            Octo::AppInit.new(enterprise: enterprise,
+                              created_at: Time.now,
+                              userid: user.id).save!
+            updateUserDeviceDetails(user, msg)
+            hook_opts.merge!({type: 'init'})
+            call_hooks(eventName, hook_opts)
+          when 'app.login'
+            Octo::AppLogin.new(enterprise: enterprise,
+                               created_at: Time.now,
+                               userid: user.id).save!
+            updateUserDeviceDetails(user, msg)
+            call_hooks(eventName, hook_opts)
+          when 'app.logout'
+            event = Octo::AppLogout.new(enterprise: enterprise,
+                                        created_at: Time.now,
+                                        userid: user.id).save!
+            updateUserDeviceDetails(user, msg)
+            call_hooks(eventName, hook_opts)
+          when 'page.view'
+            page, categories, tags = checkPage(enterprise, msg)
+            Octo::PageView.new(enterprise: enterprise,
+                               created_at: Time.now,
+                               userid: user.id,
+                               routeurl: page.routeurl
+            ).save!
+            hook_opts.merge!({type: page.routeurl})
+            updateUserDeviceDetails(user, msg)
+            call_hooks(eventName, hook_opts)
+          when 'productpage.view'
+            product, categories, tags = checkProduct(enterprise, msg)
+            Octo::ProductPageView.new(
+                                     enterprise: enterprise,
+                                     created_at: Time.now,
+                                     userid: user.id,
+                                     product_id: product.id
+            ).save!
+            updateUserDeviceDetails(user, msg)
+            hook_opts.merge!({ product: product,
+                               categories: categories,
+                               tags: tags,
+                               type: product.routeurl
+                             })
+            call_hooks(eventName, hook_opts)
+          when 'update.profile'
+            checkUserProfileDetails(enterprise, user, msg)
+            updateUserDeviceDetails(user, msg)
+            call_hooks(eventName, hook_opts)
+          when 'update.push_token'
+            checkPushToken(enterprise, user, msg)
+            checkPushKey(enterprise, msg)
+          when 'funnel_update'
+            checkRedisSession(enterprise,msg)
           end
+        end
       end
 
       private
 
+      # Make an entry of Event type
+      # @param [Octo::Enterprise] enterprise 
+      # @param [String] event_name Name of Event
       def register_api_event(enterprise, event_name)
         Octo::ApiEvent.findOrCreate({ enterprise_id: enterprise.id,
                                       eventname: event_name})
       end
 
+      # Set Octo callbacks
+      # @param [String] event Event name
+      # @param [Hash] *args Points to the messsage hash
       def call_hooks(event, *args)
         hook = [:after, event.gsub('.', '_')].join('_').to_sym
         Octo::Callbacks.run_hook(hook, *args)
@@ -158,6 +168,11 @@ module Octo
         Octo::FunnelTracker.findOrCreateOrAdjust(args_from,counters)
       end
 
+      # Creeate or Update Profile details of a user
+      # @param [Octo::Enterprise] enterprise Object of enterprise model
+      # @param [Octo::User] user Object of user model
+      # @param [Hash] msg Hash of message
+      # @return [Octo::UserProfileDetails] User Profile
       def checkUserProfileDetails(enterprise, user, msg)
         args = {
           user_id: user.id,
@@ -357,70 +372,6 @@ module Octo
         end
       end
 
-      def parse(msg)
-        msg2 = JSON.parse(msg)
-        msg = msg2
-        m = { event_name: msg['event_name'] }
-        case msg['event_name']
-          when 'funnel_update'
-            m.merge!({
-                        rediskey: msg['rediskey']
-                     })
-            # return m
-          when 'update.profile'
-            m.merge!({
-                        profileDetails: msg['profileDetails']
-                    })
-          when 'page.view'
-            m.merge!({
-                        routeUrl:     msg['routeUrl'],
-                        categories:   msg.fetch('categories', []),
-                        tags:         msg.fetch('tags', [])
-                     })
-          when 'productpage.view'
-            m.merge!({
-                        routeUrl:     msg['routeUrl'],
-                        categories:   msg.fetch('categories', []),
-                        tags:         msg.fetch('tags', []),
-                        productId:    msg['productId'],
-                        productName:  msg['productName'],
-                        price:        msg['price']
-                     })
-          when 'update.push_token'
-            m.merge!({
-                        pushType:     msg['notificationType'],
-                        pushKey:      msg['pushKey'],
-                        pushToken:    msg['pushToken']
-                     })
-        end
-        enterprise = msg['enterprise']
-        raise StandardError, 'Parse Error' if enterprise.nil?
-
-        eid = if enterprise.has_key?'custom_id'
-                enterprise['custom_id']
-              elsif enterprise.has_key?'customId'
-                enterprise['customId']
-              end
-
-        ename = if enterprise.has_key?'user_name'
-                  enterprise['user_name']
-                elsif enterprise.has_key?'userName'
-                  enterprise['userName']
-                else
-                  nil
-                end
-        m.merge!({
-            id:             msg.fetch('uuid', nil),
-            enterpriseId:   eid,
-            enterpriseName: ename,
-            phone:          msg.fetch('phoneDetails', nil),
-            browser:        msg.fetch('browserDetails', nil),
-            userId:         msg.fetch('userId', -1),
-            created_at:     Time.now
-        })
-
-        m
-      end
     end
   end
 end

data/lib/octocore/message_parser.rb

@@ -0,0 +1,99 @@
+require 'json'
+require 'set'
+
+module Octo
+  # Message abstraction module 
+  module Message
+
+    # Parsing kafka messages for octo consumer
+    module MessageParser
+    
+      # Parsing Message hash in Octo compatible form
+      # @param [Hash] Message Hash
+      # @return [Hash] Hash in Octo form
+      def parse(msg)
+        msg = JSON.parse(msg)
+        m = { event_name: msg['event_name'] }
+        case msg['event_name']
+        when 'funnel_update'
+          m.merge!({
+                    rediskey: msg['rediskey']
+                  })
+        when 'update.profile'
+          m.merge!({
+                    profileDetails: msg['profileDetails']
+                  })
+        when 'page.view'
+          m.merge!({
+                    routeUrl:     msg['routeUrl'],
+                    categories:   msg.fetch('categories', []),
+                    tags:         msg.fetch('tags', [])
+                  })
+        when 'productpage.view'
+          m.merge!({
+                    routeUrl:     msg['routeUrl'],
+                    categories:   msg.fetch('categories', []),
+                    tags:         msg.fetch('tags', []),
+                    productId:    msg['productId'],
+                    productName:  msg['productName'],
+                    price:        msg['price']
+                  })
+        when 'update.push_token'
+          m.merge!({
+                    pushType:     msg['notificationType'],
+                    pushKey:      msg['pushKey'],
+                    pushToken:    msg['pushToken']
+                  })
+        end
+        enterprise = msg['enterprise']
+        raise StandardError, 'Parse Error' if enterprise.nil?
+
+        eid = if enterprise.has_key?'custom_id'
+                enterprise['custom_id']
+              elsif enterprise.has_key?'customId'
+                enterprise['customId']
+              end
+
+        ename = if enterprise.has_key?'user_name'
+                  enterprise['user_name']
+                elsif enterprise.has_key?'userName'
+                  enterprise['userName']
+                else
+                  nil
+                end
+        m.merge!({
+          id:             msg.fetch('uuid', nil),
+          enterpriseId:   eid,
+          enterpriseName: ename,
+          phone:          msg.fetch('phoneDetails', nil),
+          browser:        msg.fetch('browserDetails', nil),
+          userId:         msg.fetch('userId', -1),
+          created_at:     Time.now
+        })
+
+        m
+      end
+
+    end
+
+    # To handle message abstraction
+    class Message
+      include MessageParser
+
+      attr_reader :message
+      
+      # Converting Message hash in Octo compatible form
+      # @param [Hash] Message Hash
+      def initialize(msg)
+        @message = msg
+      end
+
+      # To get hash message
+      # @return [Hash] Message Hash
+      def to_h
+        parse(@message)
+      end
+      
+    end
+  end
+end

data/lib/octocore/models/enterprise/funnels.rb

@@ -6,6 +6,9 @@ module Octo
 
   # Stores the funnel for the enterprise
   class Funnel
+
+    Octo.featureflag self, true
+
     include Cequel::Record
     include Octo::Record
 

data/lib/octocore/segment.rb

@@ -7,6 +7,8 @@ module Octo
   # The Segmentation module
   module Segmentation
 
+    Octo.featureflag self, true
+
     extend ActiveSupport::Concern
 
     module Helpers

data/lib/octocore/tasks.rb

@@ -0,0 +1,4 @@
+task :environment do
+end
+
+

data/lib/octocore/version.rb

@@ -1,4 +1,4 @@
 module Octo
   # The current version of the library
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octocore
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Pranav Prakash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cequel
@@ -336,16 +336,22 @@ description: |
 email: pp@octo.ai
 executables:
 - fakestream
+- octocore-admin
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
 - CHANGES.md
+- CONTRIBUTING
 - Gemfile
 - Gemfile.lock
+- LICENSE
+- MAINTAINERS
+- NOTICE
 - README.md
 - Rakefile
 - bin/fakestream
+- bin/octocore-admin
 - lib/octocore.rb
 - lib/octocore/baseline.rb
 - lib/octocore/callbacks.rb
@@ -355,6 +361,7 @@ files:
 - lib/octocore/counter.rb
 - lib/octocore/counter/helpers.rb
 - lib/octocore/email.rb
+- lib/octocore/featureflag.rb
 - lib/octocore/helpers.rb
 - lib/octocore/helpers/api_consumer_helper.rb
 - lib/octocore/helpers/api_helper.rb
@@ -366,6 +373,7 @@ files:
 - lib/octocore/kldivergence.rb
 - lib/octocore/mailer.rb
 - lib/octocore/mailer/subscriber_mailer.rb
+- lib/octocore/message_parser.rb
 - lib/octocore/models.rb
 - lib/octocore/models/contactus.rb
 - lib/octocore/models/enterprise.rb
@@ -427,6 +435,7 @@ files:
 - lib/octocore/search/setup.rb
 - lib/octocore/segment.rb
 - lib/octocore/stats.rb
+- lib/octocore/tasks.rb
 - lib/octocore/trendable.rb
 - lib/octocore/trends.rb
 - lib/octocore/utils.rb