openpanel-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ff0fc445a94bfbb173cbdf14497ffcc92822239f9db6f0ba8d6ff9825c6fa17
+  data.tar.gz: ac7759e06ca0c32474be0b03ada5c2475631dc4838aea363178e41023a4e6843
+SHA512:
+  metadata.gz: 3cbbafc13b00761bd24f0eeae536ea7162fb3beaf58ab8da8a5ac0d57f95a6cabd66cdefce2a7988f926cd52b5f29cdaf0022f657fe948fb8e87fd3ceda184fa
+  data.tar.gz: 8c9257183f18ba1fd007653b7e9846c6cd6ac9866289727234f2108ae1798b61ab97a203acf78f7ca1e5fbed777348e63310226f1c09b739a882705e12c7a7e8

data/.env_sample

@@ -0,0 +1,3 @@
+OPENPANEL_TRACK_URL=https://api.openpanel.dev/track
+OPENPANEL_CLIENT_ID=<YOUR_CLIENT_ID>
+OPENPANEL_CLIENT_SECRET=<YOUR_CLIENT_SECRET>

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 tstaetter
+
+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,39 @@
+# Openpanel::SDK
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/openpanel/sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openpanel-sdk.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/openpanel/sdk/identify_user.rb

@@ -0,0 +1,17 @@
+module OpenPanel
+  module SDK
+    class IdentifyUser
+      attr_accessor :profile_id, :email, :first_name, :last_name, :properties
+
+      def to_json
+        {
+          profileId: profile_id,
+          email: email,
+          firstName: first_name,
+          lastName: last_name,
+          properties: properties
+        }.to_json
+      end
+    end
+  end
+end

data/lib/openpanel/sdk/tracker.rb

@@ -0,0 +1,116 @@
+require "faraday"
+
+module OpenPanel
+  module SDK
+    class OpenPanelError < StandardError; end
+
+    class Tracker
+      TRACKING_TYPE_IDENTIFY = "identify"
+      TRACKING_TYPE_TRACK = "track"
+      TRACKING_TYPE_INCREMENT = "increment"
+      TRACKING_TYPE_DECREMENT = "decrement"
+
+      attr_reader :headers
+
+      ##############################
+      # Initialize OpenPanel tracker
+      ##############################
+      def initialize
+        @headers = {
+          "Content-Type" => "application/json",
+          "openpanel-client-id" => ENV["OPENPANEL_CLIENT_ID"],
+          "openpanel-client-secret" => ENV["OPENPANEL_CLIENT_SECRET"],
+        }
+      end
+
+      ##############################
+      # Set custom header for OpenPanel request
+      # @param key [String] header key
+      # @param value [String] header value
+      ##############################
+      def set_header(key, value)
+        @headers[key] = value
+      end
+
+      ##############################
+      # Track events in OpenPanel
+      # https://openpanel.dev/docs/api/track
+      # @param event [String] name of event
+      # @param tracking_type [String]
+      # @param payload [Hash] event payload
+      ##############################
+      def track(event, tracking_type: TRACKING_TYPE_TRACK, payload: {})
+        payload = { type: tracking_type, payload: { name: event, properties: payload } }
+
+        send_request payload: payload
+      end
+
+      ##############################
+      # Track page view in OpenPanel
+      # @param user [User] user to track
+      # @param path [String] page path
+      ##############################
+      def track_page_view(user, path)
+        if user
+          track "view", payload: { profileId: user.profile_id, path: path }
+        else
+          track "view", payload: { path: path }
+        end
+      end
+
+      ##############################
+      # Identify user in OpenPanel
+      # https://openpanel.dev/docs/api/track
+      # @param user [OpenPanel::SDK::IdentifyUser] user to identify
+      ##############################
+      def identify(user)
+        payload = { profileId: user.profile_id, firstName: user.first_name, lastName: user.last_name, email: user.email }
+        payload = { type: TRACKING_TYPE_IDENTIFY, payload: payload }
+
+        send_request payload: payload
+      end
+
+      def increment_property(user, property = "visits", value = 1)
+        payload = { profileId: user.profile_id, property: property, value: value }
+        payload = { type: TRACKING_TYPE_INCREMENT, payload: payload }
+
+        send_request payload: payload
+      end
+
+      ##############################
+      # Decrement property in OpenPanel
+      # @param user [User] user to identify
+      #############################
+      def decrement_property(user, property = "visits", value = 1)
+        payload = { profileId: user.profile_id, property: property, value: value }
+        payload = { type: TRACKING_TYPE_DECREMENT, payload: payload }
+
+        send_request payload: payload
+      end
+
+      private
+
+      ##############################
+      # Send request to OpenPanel API
+      # @param url [String] API endpoint URL
+      # @param payload [Hash] request payload
+      ##############################
+      def send_request(url: ENV["OPENPANEL_TRACK_URL"], payload: {})
+        response = Faraday.post url, payload.to_json, @headers
+
+        case response.status
+        when 401
+          raise OpenPanel::SDK::OpenPanelError, "Unauthorized"
+        when 429
+          raise OpenPanel::SDK::OpenPanelError, "Too many requests"
+        when 500
+          raise OpenPanel::SDK::OpenPanelError, "Internal server error"
+        else
+          response
+        end
+      rescue StandardError => e
+        raise OpenPanel::SDK::OpenPanelError, e.message
+      end
+    end
+  end
+end

data/lib/openpanel/sdk/version.rb

@@ -0,0 +1,5 @@
+module OpenPanel
+  module SDK
+    VERSION = "0.1.0"
+  end
+end

data/lib/openpanel/sdk.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "sdk/identify_user"
+require_relative "sdk/tracker"
+require_relative "sdk/version"

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: openpanel-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Stätter
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-11-28 00:00:00.000000000 Z
+dependencies: []
+description: OpenPanel SDK for Ruby
+email:
+- Thomas Stätter <thomas.staetter@gmail.com>
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env_sample"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/openpanel/sdk.rb
+- lib/openpanel/sdk/identify_user.rb
+- lib/openpanel/sdk/tracker.rb
+- lib/openpanel/sdk/version.rb
+homepage: https://github.com/tstaetter/openpanel-sdk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tstaetter/openpanel-sdk
+  source_code_uri: https://github.com/tstaetter/openpanel-sdk
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: OpenPanel SDK for Ruby
+test_files: []