ahoy_panel 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84e7f7e4d1cb11801db2816bc4e4f448ef4322276139bb44afac6806581fe2c3
-  data.tar.gz: 2b05fbfac068ba5013f983301ae008f2e13be362567c85110ccfa31b904ac187
+  metadata.gz: 30ad1497fbf5bf2457d257333673b84c928df34e620669bdd54139f6e08139ef
+  data.tar.gz: 0edb2465e6c4780691b4ccdac95e26eaafe9d2e2b083396664fb8e05f2c7dc96
 SHA512:
-  metadata.gz: de0b39d73b7cee4a3a7378d9a05e1c0f281191680f770b755bacb9eb04e7835db44cb48ce268fafc288a48b36888b0f52eb9a2797b8e48fb4585c512efe4ed67
-  data.tar.gz: 154b5cc04a47ae153126cd86b686b1e24c78f89250d48241ad37bd535d8e2eee6ea4452c4deca2eca23cb520c414d8653096b1839a5185e29b51384a6703a566
+  metadata.gz: a66637704dab635875a85244c19f2937c3ca54d85e5df9fbe079516def52dc27d991c94db4714f41796cfe4290967719002fb37e49e7e3321a0e9bcc5e8565d3
+  data.tar.gz: b1e106a8825fd6f90db2eb52dd37dbd1f51c37bdb9e94a8ceb98d37f0030584a550cb75c0afa28e7c9ab2f0cd9de6d53c98e2ece401b7e0bf188c4a01a8b2580

data/README.md

@@ -1,28 +1,96 @@
-# AhoyPanel
-Short description and motivation.
+# Ahoy Panel
 
-## Usage
-How to use my plugin.
+[![Gem Version](https://badge.fury.io/rb/ahoy_panel.svg)](https://badge.fury.io/rb/ahoy_panel)
+
+**Ahoy Panel** is a companion gem for the [Ahoy Panel](https://www.ahoypanel.com) web app – a modern, hosted dashboard for your [Ahoy](https://github.com/ankane/ahoy) analytics data.
+
+It enables your Rails app to stream Ahoy events to the Ahoy Panel API for real-time analytics and beautiful insights.
+
+---
+
+## Features
+
+- 🔌 Simple integration with your existing Ahoy setup  
+- 📊 Centralized dashboard at [ahoypanel.com](https://www.ahoypanel.com)  
+- 🚀 Lightweight and configurable  
+- 🔐 Secure API key-based authentication  
+
+---
 
 ## Installation
-Add this line to your application's Gemfile:
+
+Add this line to your Rails application's Gemfile:
 
 ```ruby
 gem "ahoy_panel"
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+bundle install
 ```
 
-Or install it yourself as:
+---
+
+## Configuration
+
+After installing the gem, you'll need to configure it to connect to your Ahoy Panel account. This gem assumes that you already have `ahoy_matey` gem installed, configured, and in usage.
+
+Create an initializer file:
+
+```ruby
+# config/initializers/ahoy_panel.rb
+AhoyPanel.configure do |config|
+  # Your project’s API key from https://www.ahoypanel.com/settings
+  config.api_key = ENV.fetch("AHOY_PANEL_API_KEY")
+end
+```
+
+Add your API key to your environment variables:
+
 ```bash
-$ gem install ahoy_panel
+# .env
+AHOY_PANEL_API_KEY=your-api-key-here
 ```
 
+---
+
+## Usage
+
+Once configured, anytime you load your dashboard in [Ahoy Panel](https://www.ahoypanel.com), your `ahoy_panel` will send the data that's needed `Ahoy::Visit` and `Ahoy::Event` to [Ahoy Panel](https://www.ahoypanel.com) to build the dashboard.
+
+No extra setup required – just install, configure, and you're done! 🎉
+
+---
+
+## Requirements
+
+- Rails 6+
+- [Ahoy](https://github.com/ankane/ahoy) gem installed and configured
+
+---
+
+## Privacy & Performance
+
+- Events are batched and sent asynchronously to minimize request overhead  
+- Only relevant event data (like `name`, `properties`, `user_id`, and timestamps) is sent  
+- You retain full control over what data is tracked  
+
+---
+
+## Troubleshooting
+
+- Ensure your API key is correct and the base_url configured in your [Ahoy Panel](https://www.ahoypanel.com) account is correct. Any issues, reach out.
+
+---
+
 ## Contributing
-Contribution directions go here.
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/typefastco/ahoy_panel](https://github.com/typefastco/ahoy_panel).
+
+---
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/ahoy_panel/application_controller.rb

@@ -1,4 +1,29 @@
 module AhoyPanel
   class ApplicationController < ActionController::Base
+    before_action :authenticate_api_key!
+
+    protected
+
+    def authenticate_api_key!
+      api_key = request.headers["Ahoy-Panel-Api-Key"]
+
+      return true if Rails.env.development?
+
+      ahoy_panel_root_url = "https://www.ahoypanel.com"
+
+      client = Faraday.new(url: ahoy_panel_root_url) do |conn|
+        conn.headers["Ahoy-Panel-Api-Key"] = "#{api_key}"
+        conn.request :json
+        conn.response :json
+      end
+
+      response = client.get("/api_key_verify")
+
+      client = Faraday.new(url: ahoy_panel_root_url)
+
+      if !response.body["verified"]
+        client.get("/invalid_api_key")
+      end
+    end
   end
 end

data/app/controllers/ahoy_panel/views_data_controller.rb

@@ -0,0 +1,12 @@
+module AhoyPanel
+  class ViewsDataController < ApplicationController
+    def index
+      @start_date = params[:start_date].to_date
+      @end_date = params[:end_date].to_date
+
+      @visits = ::Ahoy::Visit.where(started_at: @start_date..@end_date)
+
+      render json: @visits
+    end
+  end
+end

data/app/controllers/ahoy_panel/visits_controller.rb

@@ -1,9 +1,13 @@
 module AhoyPanel
   class VisitsController < ApplicationController
-    def index
-      @visits = ::Ahoy::Visit.all
+    def all_time_dates
+      start_date = ::Ahoy::Visit.order(started_at: :asc).first.started_at.to_date
+      end_date = ::Ahoy::Visit.order(started_at: :desc).first.started_at.to_date
 
-      render json: @visits
+      render json: {
+        start_date: start_date,
+        end_date: end_date
+      }
     end
   end
 end

data/config/routes.rb

@@ -1,3 +1,5 @@
 AhoyPanel::Engine.routes.draw do
-  resources :visits
+  get "all_time_dates", to: "visits#all_time_dates"
+
+  get "views_data", to: "views_data#index"
 end

data/lib/ahoy_panel/version.rb

@@ -1,3 +1,3 @@
 module AhoyPanel
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/lib/ahoy_panel.rb

@@ -1,6 +1,7 @@
 require "ahoy_panel/version"
 require "ahoy_panel/engine"
-require 'dry-configurable'
+require "dry-configurable"
+require "faraday"
 
 module AhoyPanel
   extend Dry::Configurable

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_panel
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Chris Jeon
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: ahoy_matey
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
 description: Ahoy is a great analytics tracking gem. AhoyPanel is a great dashboard
   for the data collected by Ahoy.
 email:
@@ -64,6 +78,7 @@ files:
 - Rakefile
 - app/assets/stylesheets/ahoy_panel/application.css
 - app/controllers/ahoy_panel/application_controller.rb
+- app/controllers/ahoy_panel/views_data_controller.rb
 - app/controllers/ahoy_panel/visits_controller.rb
 - app/helpers/ahoy_panel/application_helper.rb
 - app/jobs/ahoy_panel/application_job.rb