evntaly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f33c5ed1efa2540d8f4180cc2918d57e3e3d0e54ee2508b5306ff096c8f34784
+  data.tar.gz: e981103ffa7558e04c875127664a78dafb22ecc81cc0686b1088488f44306c90
+SHA512:
+  metadata.gz: 47762429b717e8d0d33544dcc81d7aee6637bc58156c6af5212ec4095ec2cee6225344dd1d39461fdca23e4c6088a5bc9cd9b1bad1dbb4c922018b8919b48e43
+  data.tar.gz: f0f85d9fce0bdfaedb815bdb2d1f11e9fe76d60b54461f16fe1b2fd1e7ed197b1fb0f90c4c15e0fb82491dd7ffa4b29194c3c13cec99b3db169a49789b35262f

data/.gitignore

@@ -0,0 +1,3 @@
+.rspec_status
+.byebug_history
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    evntaly (1.0.0)
+      json (~> 2.5)
+      net-http (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (12.0.0)
+    diff-lcs (1.6.1)
+    json (2.10.2)
+    net-http (0.1.1)
+      net-protocol
+      uri
+    net-protocol (0.2.2)
+      timeout
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    timeout (0.4.3)
+    uri (1.0.3)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  byebug
+  evntaly!
+  rake (~> 13.0)
+  rspec (~> 3.10)
+
+BUNDLED WITH
+   2.5.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Evntaly
+
+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,116 @@
+<p align="center">
+  <img src="https://cdn.evntaly.com/Resources/og.png" alt="Evntaly Cover" width="100%">
+</p>
+
+<h3 align="center">Evntaly</h3>
+
+<p align="center">
+ An advanced event tracking and analytics platform designed to help developers capture, analyze, and react to user interactions efficiently.
+</p>
+<p align="center">
+  <a href="https://github.com/Evntaly/evntaly-ruby"><img src="https://img.shields.io/github/license/Evntaly/evntaly-ruby" alt="license"></a>
+</p>
+
+# evntaly-ruby
+**EvntalySDK** is a ruby gem for interacting with the Evntaly event tracking platform. It provides methods to initialize tracking, log events, identify users, and check API usage limits.
+
+## Features
+
+- **Initialize** the SDK with a developer secret and project token.
+- **Track events** with metadata and tags.
+- **Identify users** for personalization and analytics.
+- **Enable or disable** tracking globally.
+
+## Installation
+
+To install the SDK using `bundler`:
+
+```sh
+ gem 'evntaly', github: 'github.com/Evntaly/evntaly-ruby'
+```
+and then run:
+```
+bundle install
+```
+
+## Usage
+
+### Initialization
+
+Initialize the SDK with your developer secret and project token:
+
+```ruby
+sdk = Evntaly::SDK.new(
+    developer_secret: 'YOUR_DEVELOPER_SECRET',
+    project_token: 'YOUR_PROJECT_TOKEN'
+)
+```
+
+### Tracking Events
+
+To track an event:
+
+```ruby
+ event = Evntaly::Event.new(
+  title: 'User Signed Up',
+  description: 'A new user signed up to the platform.',
+  message: 'Welcome email sent to the user.',
+  data: { plan: 'pro', referrer: 'campaign_xyz' },
+  tags: ['signup', 'email', 'marketing'],
+  notify: true,
+  icon: "💰",
+  apply_rule_only: false,
+  user: { id: '12345' },
+  type: 'user_event',
+  session_id: 'session_abc',
+  feature: 'onboarding',
+  topic: 'user_activity'
+)
+
+begin
+  sdk.track(event)
+rescue => e
+  # error handling logic
+end
+```
+
+### Identifying Users
+
+To identify a user:
+
+```ruby
+user = Evntaly::User.new(
+  id: 'u123',
+  email: 'user@example.com',
+  full_name: 'John Doe',
+  organization: 'Example Org',
+  data: { role: 'admin' }
+)
+
+begin
+  sdk.identify_user(user)
+rescue => e
+  # error handling logic
+end
+```
+
+### Enabling/Disabling Tracking
+
+Control event tracking globally:
+
+```ruby
+ Evntaly::SDK.disable_tracking  # Disables tracking
+ Evntaly::SDK.enable_tracking   # Enables tracking
+```
+And to check if tracking is enabled, do:
+```ruby
+ Evntaly::SDK.tracking_enabled?
+```
+
+## License
+
+This project is licensed under the MIT License.
+
+---
+
+*Note: Replace **`"YOUR_DEVELOPER_SECRET"`** and **`"YOUR_PROJECT_TOKEN"`** with actual credentials.*

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+module Tools
+  class Releaser < Bundler::GemHelper
+    def release(remote='origin')
+      tag_version do
+        git_push(remote)
+      end unless already_tagged?
+    end
+  end
+end
+
+desc 'Creates a tag using version.rb and pushes it to GitHub'
+task 'gh-release', [:remote] do
+  Tools::Releaser.new.release
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "evntaly"
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/evntaly.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/evntaly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "evntaly"
+  spec.version       = Evntaly::VERSION
+  spec.authors       = ["Sayed Alesawy"]
+
+  spec.summary       = "Evntaly official library for your ruby projects"
+  spec.homepage      = "https://github.com/Evntaly/evntaly-ruby"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.require_paths = ["lib"]
+
+  # Add dependencies here
+  spec.add_runtime_dependency "net-http", "~> 0.1.0"
+  spec.add_runtime_dependency "json", "~> 2.5"
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency 'byebug'
+
+  # post-install message
+  spec.post_install_message = "Thank you for using the Evntaly SDK. For more details, visit https://evntaly.com"
+end

data/lib/evntaly/event.rb

@@ -0,0 +1,40 @@
+module Evntaly
+  class Event
+    attr_accessor :title, :description, :message, :data, :tags, :notify, :icon,
+                  :apply_rule_only, :user, :type, :session_id, :feature, :topic
+
+    def initialize(title:, description:, message:, data:, tags:, notify:, icon:, apply_rule_only:, user:, type:, session_id:, feature:, topic:)
+      @title = title
+      @description = description
+      @message = message
+      @data = data
+      @tags = tags
+      @notify = notify
+      @icon = icon
+      @apply_rule_only = apply_rule_only
+      @user = user
+      @type = type
+      @session_id = session_id
+      @feature = feature
+      @topic = topic
+    end
+
+    def to_json(*_args)
+      {
+        title: @title,
+        description: @description,
+        message: @message,
+        data: @data,
+        tags: @tags,
+        notify: @notify,
+        icon: @icon,
+        apply_rule_only: @apply_rule_only,
+        user: @user,
+        type: @type,
+        session_id: @session_id,
+        feature: @feature,
+        topic: @topic
+      }.to_json
+    end
+  end
+end

data/lib/evntaly/sdk.rb

@@ -0,0 +1,110 @@
+require "net/http"
+require "json"
+require "uri"
+
+module Evntaly
+  class SDK
+    attr_accessor :base_url, :developer_secret, :project_token, :timeout
+
+    @@tracking_enabled = true
+
+    def initialize(developer_secret:, project_token:)
+      @base_url = "https://app.evntaly.com/prod"
+      @developer_secret = developer_secret
+      @project_token = project_token
+    end
+
+    def set_timeout(seconds)
+      @timeout = seconds
+    end
+
+    def check_limit
+      uri = URI("#{base_url}/api/v1/account/check-limits/#{developer_secret}")
+      request = Net::HTTP::Get.new(uri, "Content-Type" => "application/json")
+
+      response = send_request(uri, request)
+
+      result = JSON.parse(response.body)
+      raise "Unexpected API response format" unless result.key?("limitReached")
+
+      !result["limitReached"]
+    rescue => e
+      puts "Error checking limit: #{e.message}"
+      false
+    end
+
+    def track(event)
+      unless self.class.tracking_enabled?
+        puts "Tracking is disabled. Event not sent."
+        return
+      end
+
+      unless check_limit
+        puts "checkLimit returned false. Event not sent."
+        return
+      end
+
+      uri = URI("#{base_url}/api/v1/register/event")
+      request = Net::HTTP::Post.new(uri)
+      request["Content-Type"] = "application/json"
+      request["secret"] = developer_secret
+      request["pat"] = project_token
+      request.body = event.to_json
+
+      response = send_request(uri, request)
+
+      unless response.code.to_i.between?(200, 299)
+        raise "Failed to track event: status code #{response.code}"
+      end
+
+      puts "✅ Event tracked successfully"
+    end
+
+    def identify_user(user)
+      uri = URI("#{base_url}/api/v1/register/user")
+      request = Net::HTTP::Post.new(uri)
+      request["Content-Type"] = "application/json"
+      request["secret"] = developer_secret
+      request["pat"] = project_token
+      request.body = user.to_json
+
+      response = send_request(uri, request)
+
+      unless response.code.to_i.between?(200, 299)
+        raise "Failed to identify user: status code #{response.code}"
+      end
+
+      puts "✅ User identified successfully"
+
+      true
+    end
+
+    def self.tracking_enabled?
+      @@tracking_enabled
+    end
+
+    def self.disable_tracking
+      @@tracking_enabled = false
+      puts "🚫 Tracking disabled."
+    end
+
+    def self.enable_tracking
+      @@tracking_enabled = true
+      puts "🟢 Tracking enabled."
+    end
+
+    private
+
+    def send_request(uri, request)
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: true, open_timeout: @timeout, read_timeout: @timeout) do |http|
+        http.request(request)
+      end
+    rescue Net::OpenTimeout
+      raise "Request timed out (open timeout)"
+    rescue Net::ReadTimeout
+      raise "Request timed out (read timeout)"
+    rescue StandardError => e
+      raise "Network error: #{e.message}"
+    end
+  end
+end

data/lib/evntaly/user.rb

@@ -0,0 +1,23 @@
+module Evntaly
+  class User
+    attr_accessor :id, :email, :full_name, :organization, :data
+
+    def initialize(id:, email:, full_name:, organization:, data:)
+      @id = id
+      @email = email
+      @full_name = full_name
+      @organization = organization
+      @data = data
+    end
+
+    def to_json(*_args)
+      {
+        id: @id,
+        email: @email,
+        full_name: @full_name,
+        organization: @organization,
+        data: @data
+      }.to_json
+    end
+  end
+end

data/lib/evntaly/version.rb

@@ -0,0 +1,3 @@
+module Evntaly
+  VERSION = "1.0.0"
+end

data/lib/evntaly.rb

@@ -0,0 +1,7 @@
+require_relative 'evntaly/version'
+
+module Evntaly
+  autoload :Event, 'evntaly/event'
+  autoload :User, 'evntaly/user'
+  autoload :SDK, 'evntaly/sdk'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: evntaly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sayed Alesawy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- evntaly.gemspec
+- lib/evntaly.rb
+- lib/evntaly/event.rb
+- lib/evntaly/sdk.rb
+- lib/evntaly/user.rb
+- lib/evntaly/version.rb
+homepage: https://github.com/Evntaly/evntaly-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Evntaly/evntaly-ruby
+post_install_message: Thank you for using the Evntaly SDK. For more details, visit
+  https://evntaly.com
+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.5.18
+signing_key:
+specification_version: 4
+summary: Evntaly official library for your ruby projects
+test_files: []