behavior_lens 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcf311493b6a1b9f107e36c03d07508311bb475401aac8b3a6f2424e57df74a6
+  data.tar.gz: 3c260211af74b8b8ccba7b474a6300e10224090e1304d3eb3020fbdded28ee31
+SHA512:
+  metadata.gz: 79cc4d5b153f276c0351fe688c2a9f3be13bd2c2a1b350577567d0dfc1e2b9baae090b782eedd2db235f6be4962ed31e9df86635dee1dbf15c164583f1d16857
+  data.tar.gz: cb19954c1ea4f8a737a73e38c3d3ec84aa14cbcea19547f9e2afa28b2067402faf3ae7c972dd4ef5e7a76eadab86f8c3c83c8cdbab8553433ac2ca3900e521f1

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-03
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in BehaviorLens.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    behavior_lens (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.6)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  behavior_lens!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.5.18

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 aayushhum
+
+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,91 @@
+# BehaviorLens
+
+BehaviorLens is a Ruby gem designed to provide insights into user behavior and interaction patterns, enabling developers to understand and optimize user experiences.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'behavior_lens'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install behavior_lens
+```
+
+## Usage
+
+To use BehaviorLens in your project, require the gem and start analyzing behavior patterns. Here's a quick example:
+
+```ruby
+require 'behavior_lens'
+
+# Example: Analyzing a set of user actions
+analyzer = BehaviorLens::Analyzer.new
+analyzer.track("user_clicked_button")
+analyzer.track("user_scrolled_page")
+
+report = analyzer.generate_report
+puts report
+```
+
+Detailed documentation for advanced usage will be available soon.
+
+## Development
+
+To get started with development:
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/aayush502/behavior_lens.git
+   cd behavior_lens
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   bin/setup
+   ```
+
+3. Run the interactive console for experimentation:
+
+   ```bash
+   bin/console
+   ```
+
+4. To build and install the gem locally:
+
+   ```bash
+   bundle exec rake install
+   ```
+
+5. To release a new version:
+
+   - Update the version number in `lib/behavior_lens/version.rb`.
+   - Run:
+     ```bash
+     bundle exec rake release
+     ```
+   - This will tag the version, push changes to GitHub, and publish the gem to [RubyGems](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/aayush502/behavior\_lens](https://github.com/aayush502/behavior_lens). Contributions are expected to adhere to the [Code of Conduct](https://github.com/aayush502/behavior_lens/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+BehaviorLens is open source and available under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+All participants in the BehaviorLens project are expected to follow the [Code of Conduct](https://github.com/aayush502/behavior_lens/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/behavior_lens.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'lib/behavior_lens/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'behavior_lens'
+  spec.version = BehaviorLens::VERSION
+  spec.authors = ['Aayush Humagain']
+  spec.email = ['aayushhumagain23@gmail.com']
+
+  spec.summary = 'A comprehensive user tracking library for Ruby.'
+  spec.description = 'behavior_lens provides advanced tools for tracking user activity,
+  sessions, custom events, click heatmaps, and more. It supports real-time updates,
+  customizable reports, and data persistence for detailed analysis.'
+
+  spec.homepage = 'https://github.com/aayush502/behaviour_lens'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['documentation_uri'] = 'https://github.com/aayush502/behaviour_lens/wiki'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/aayush502/behaviour_lens'
+  spec.metadata['changelog_uri'] = 'https://github.com/aayush502/behaviour_lens/blob/master/CHANGELOG.md'
+
+  spec.post_install_message = 'Thank you for installing BehaviorLens! Check out https://github.com/aayush502/behaviour_lens for usage instructions.'
+  spec.add_dependency 'dependency_name', '~> 1.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  # 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.
+  File.basename(__FILE__)
+  # spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+  #   ls.readlines("\x0", chomp: true).reject do |f|
+  #     (f == gemspec) ||
+  #       f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+  #   end
+  # end
+  # spec.files = Dir['{lib,sig}/**/*', '*.md', '*.txt', 'Rakefile']
+  spec.files = `git ls-files`.split("\n")
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "behavior_lens"
+
+# 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.
+
+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/lib/behavior_lens/click_tracker.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BehaviorLens
+  class ClickTracker
+    def initialize
+      @clicks = Hash.new(0)
+    end
+
+    def track(link)
+      @clicks[link] += 1
+    end
+
+    def most_clicked
+      @clicks.max_by { |_, count| count }
+    end
+
+    def report
+      @clicks
+    end
+  end
+end

data/lib/behavior_lens/event_tracker.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BehaviorLens
+  class EventTracker
+    def initialize
+      @events = []
+    end
+
+    def track(event_name, metadata = {})
+      @events << { name: event_name, timestamp: Time.now, metadata: metadata }
+    end
+
+    def report
+      @events
+    end
+  end
+end

data/lib/behavior_lens/report_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'csv'
+
+module BehaviorLens
+  class ReportGenerator
+    def self.generate(click_tracker, session_tracker, event_tracker, format)
+      data = {
+        clicks: click_tracker.report,
+        sessions: session_tracker.report,
+        events: event_tracker.report
+      }
+
+      case format
+      when :json
+        JSON.pretty_generate(data)
+      when :csv
+        CSV.generate do |csv|
+          csv << %w[Category Item Value]
+
+          # Format clicks
+          data[:clicks].each do |url, count|
+            csv << ['Click', url, count]
+          end
+
+          # Format sessions
+          data[:sessions].each do |user_id, session|
+            csv << ['Session', user_id, "Start: #{session[:start_time]}, End: #{session[:end_time]}"]
+          end
+
+          # Format events
+          data[:events].each do |event|
+            csv << ['Event', event[:name], event[:metadata].to_json]
+          end
+        end
+      else
+        data.to_s
+      end
+    end
+  end
+end

data/lib/behavior_lens/session_tracker.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BehaviorLens
+  class SessionTracker
+    def initialize
+      @sessions = {}
+    end
+
+    def start(user_id)
+      @sessions[user_id] = { start_time: Time.now, end_time: nil }
+    end
+
+    def end(user_id)
+      return unless @sessions[user_id] && @sessions[user_id][:start_time]
+
+      @sessions[user_id][:end_time] = Time.now
+    end
+
+    def report
+      @sessions
+    end
+  end
+end

data/lib/behavior_lens/tracker.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module BehaviorLens
+  class Tracker
+    def initialize
+      @click_tracker = ClickTracker.new
+      @session_tracker = SessionTracker.new
+      @event_tracker = EventTracker.new
+    end
+
+    # Delegates most_clicked to ClickTracker
+    def most_clicked
+      @click_tracker.most_clicked
+    end
+
+    def track_click(link)
+      @click_tracker.track(link)
+    end
+
+    def start_session(user_id)
+      @session_tracker.start(user_id)
+    end
+
+    def end_session(user_id)
+      @session_tracker.end(user_id)
+    end
+
+    def track_event(event_name, metadata = {})
+      @event_tracker.track(event_name, metadata)
+    end
+
+    def generate_report(format: :json)
+      ReportGenerator.generate(@click_tracker, @session_tracker, @event_tracker, format)
+    end
+  end
+end

data/lib/behavior_lens/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BehaviorLens
+  VERSION = "0.1.0"
+end

data/lib/behavior_lens.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'behavior_lens/tracker'
+require_relative 'behavior_lens/version'
+require_relative 'behavior_lens/click_tracker'
+require_relative 'behavior_lens/session_tracker'
+require_relative 'behavior_lens/event_tracker'
+require_relative 'behavior_lens/report_generator'
+
+module BehaviorLens
+  class Error < StandardError; end
+end

data/sig/BehaviorLens.rbs

@@ -0,0 +1,4 @@
+module BehaviorLens
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: behavior_lens
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aayush Humagain
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dependency_name
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  behavior_lens provides advanced tools for tracking user activity,
+    sessions, custom events, click heatmaps, and more. It supports real-time updates,
+    customizable reports, and data persistence for detailed analysis.
+email:
+- aayushhumagain23@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- behavior_lens.gemspec
+- bin/console
+- bin/setup
+- lib/behavior_lens.rb
+- lib/behavior_lens/click_tracker.rb
+- lib/behavior_lens/event_tracker.rb
+- lib/behavior_lens/report_generator.rb
+- lib/behavior_lens/session_tracker.rb
+- lib/behavior_lens/tracker.rb
+- lib/behavior_lens/version.rb
+- sig/BehaviorLens.rbs
+homepage: https://github.com/aayush502/behaviour_lens
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  documentation_uri: https://github.com/aayush502/behaviour_lens/wiki
+  homepage_uri: https://github.com/aayush502/behaviour_lens
+  source_code_uri: https://github.com/aayush502/behaviour_lens
+  changelog_uri: https://github.com/aayush502/behaviour_lens/blob/master/CHANGELOG.md
+post_install_message: Thank you for installing BehaviorLens! Check out https://github.com/aayush502/behaviour_lens
+  for usage instructions.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: A comprehensive user tracking library for Ruby.
+test_files: []