plausible_api 0.1.9 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946cc54d639da26e6d4e835df896ed3aa2237e9abf9c184085c28c7eafff0497
-  data.tar.gz: c98ccc5b1060614edc3141282589fa5158d1367544699efadb89c5ff9aecb0f0
+  metadata.gz: 77c960fb14e022fa7f1ae47a7c38903325d188d98c67ac598977812326b616be
+  data.tar.gz: 4d0ed7d883293c49bfb518d544efbad968b544d249cb0bfc05ff5366c87a325e
 SHA512:
-  metadata.gz: 9ce81d99cd4cce297c3cd388af7836e7f1415d6b5a04e83e51da7e44ba3bb042c8a97e7f9c059e1f1c69ad688e306c9cb98ed6c360e6afe26b908075a52e0063
-  data.tar.gz: 21f54c76bd3a314748258681f34604e93928c257e663ff0f5df33bad13b5d5189feb9ecad6b1360e276160ad4dd11aa1e91c825ea2e2b8105827a6a63dbfdb17
+  metadata.gz: 6247be2a8f503c75bbff787771f1189598426171275122b6dddcc6581354db6ea3e2f81dd5c0ccc247c92ab7587f5f00c32ccc3d83b050ab70ff1470866bbbcb
+  data.tar.gz: 395a7b263fcfb9ce374f7e2d734a3d2ed608fd11755c4a6087fabc89a299da084fe5411063707e7066371660c1784ca2fa900d434d0daaefe8f00c398974dd7e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plausible_api (0.1.9)
+    plausible_api (0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -9,7 +9,7 @@ gem 'plausible_api'
 ```
 Then you need to initialize a Client with your `site_id` (the domain) and your `token`.
 ```rb
-c = PlausibleApi::Client.new('dailytics.com', '123123') 
+c = PlausibleApi::Client.new('dailytics.com', '123123')
 
 # Test if the site and token are valid
 c.valid?
@@ -73,6 +73,19 @@ c.realtime_visitors
 => 13
 ```
 
+### Events
+
+You can send an event like this:
+
+```rb
+# Example using Rack::Request in Rails for user_agent and ip.
+c.event({
+  name: "signup",
+  url: 'https://dailytics.com/users/new',
+  user_agent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.3",
+  ip: "127.0.0.1"
+})
+```
 
 ## Development
 

data/examples/basic.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'plausible_api'
+
+client = PlausibleApi::Client.new(ENV["SITE_ID"], ENV["TOKEN"])
+p client.valid?

data/examples/event.rb

@@ -0,0 +1,23 @@
+require 'bundler/setup'
+require 'plausible_api'
+
+client = PlausibleApi::Client.new(ENV["SITE_ID"], ENV["TOKEN"])
+
+# default all the things, pointless but works
+p client.event
+
+# change the name
+p client.event(
+  name: "test",
+)
+
+# send the whole kitchen sink
+p client.event(
+  ip: "127.0.0.1",
+  user_agent: "test",
+  name: "test",
+  url: "app://localhost/test",
+  referrer: "https://example.com",
+  revenue: {currency: "USD", amount: 1.00},
+  props: {foo: "bar"},
+)

data/lib/plausible_api/client.rb

@@ -1,24 +1,25 @@
 # frozen_string_literal: true
 
-require 'plausible_api/stats/base'
-require 'plausible_api/stats/realtime/visitors'
-require 'plausible_api/stats/aggregate'
-require 'plausible_api/stats/timeseries'
-require 'plausible_api/stats/breakdown'
+require "plausible_api/stats/base"
+require "plausible_api/stats/realtime/visitors"
+require "plausible_api/stats/aggregate"
+require "plausible_api/stats/timeseries"
+require "plausible_api/stats/breakdown"
+require "plausible_api/event/base"
+require "plausible_api/event/post"
 
-require 'json'
+require "json"
 require "net/http"
 require "uri"
 require "cgi"
 
 module PlausibleApi
   class Client
-    
-    BASE_URL = 'https://plausible.io'
+    BASE_URL = "https://plausible.io"
 
     def initialize(site_id, token)
       @site_id = site_id.to_s
-      @token   = token.to_s
+      @token = token.to_s
     end
 
     def aggregate(options = {})
@@ -38,34 +39,41 @@ module PlausibleApi
     end
 
     def valid?
-      begin
-        realtime_visitors
-        return true
-      rescue
-        return false
-      end
+      realtime_visitors
+      true
+    rescue
+      false
+    end
+
+    def event(options = {})
+      call PlausibleApi::Event::Post.new(options.merge(domain: @site_id))
     end
 
     private
-    def call(api)      
+
+    SUCCESS_CODES = %w[200 202].freeze
+
+    def call(api)
       raise StandardError.new api.errors unless api.valid?
-      
-      url = "#{BASE_URL}#{api.request_url.gsub('$SITE_ID', @site_id)}"
+
+      url = "#{BASE_URL}#{api.request_url.gsub("$SITE_ID", @site_id)}"
       uri = URI.parse(url)
 
-      req = Net::HTTP::Get.new(uri.request_uri)
-      req.add_field('Authorization', "Bearer #{@token}")
+      req = api.request_class.new(uri.request_uri)
+      req.initialize_http_header(api.request_headers)
+      req.add_field("authorization", "Bearer #{@token}") if api.request_auth?
+      req.body = api.request_body if api.request_body?
 
       http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true  
+      http.use_ssl = true
 
       response = http.request(req)
 
-      if response.code == "200"
+      if SUCCESS_CODES.include?(response.code)
         api.parse_response response.body
       else
         raise StandardError.new response.body
       end
     end
   end
-end
+end

data/lib/plausible_api/event/base.rb

@@ -0,0 +1,31 @@
+module PlausibleApi
+  module Event
+    class Base
+      DEFAULT_USER_AGENT = "plausible_api_ruby/#{PlausibleApi::VERSION}"
+
+      def request_class
+        Net::HTTP::Post
+      end
+
+      def request_url_base
+        "/api/event"
+      end
+
+      def request_url
+        request_url_base
+      end
+
+      def request_auth?
+        false
+      end
+
+      def request_body?
+        true
+      end
+
+      def valid?
+        errors.empty?
+      end
+    end
+  end
+end

data/lib/plausible_api/event/post.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Event
+    class Post < Base
+      DEFAULT_USER_AGENT = "plausible_api_ruby/#{PlausibleApi::VERSION}"
+      VALID_REVENUE_KEYS = %i[amount currency].freeze
+      OPTIONS_IN_HEADERS = %i[ip user_agent].freeze
+
+      attr_reader :domain
+      attr_reader :ip, :user_agent, :url
+      attr_reader :name, :props, :referrer, :revenue
+
+      def initialize(options = {})
+        @options = options.transform_keys(&:to_sym)
+
+        @domain = @options[:domain]
+        @ip = @options[:ip]
+        @user_agent = presence(@options[:user_agent]) || DEFAULT_USER_AGENT
+        @name = presence(@options[:name]) || "pageview"
+        @url = presence(@options[:url]) || "app://localhost/#{@name}"
+        @referrer = @options[:referrer]
+        @revenue = @options[:revenue]
+        @props = @options[:props]
+      end
+
+      def request_body
+        data = {
+          url: @url,
+          name: @name,
+          domain: @domain
+        }
+
+        data[:props] = @props if present?(@props)
+        data[:revenue] = @revenue if present?(@revenue)
+        data[:referrer] = @referrer if present?(@referrer)
+
+        JSON.generate(data)
+      end
+
+      def request_headers
+        headers = {
+          "content-type" => "application/json",
+          "user-agent" => @user_agent
+        }
+        headers["x-forwarded-for"] = @ip if present?(@ip)
+        headers
+      end
+
+      def parse_response(body)
+        body == "ok"
+      end
+
+      def errors
+        errors = []
+        errors.push(url: "url is required") if blank?(@url)
+        errors.push(name: "name is required") if blank?(@name)
+        errors.push(domain: "domain is required") if blank?(@domain)
+        errors.push(user_agent: "user_agent is required") if blank?(@user_agent)
+
+        if present?(@revenue)
+          if @revenue.is_a?(Hash)
+            unless valid_revenue_keys?(@revenue)
+              errors.push(
+                revenue: "revenue must have keys #{VALID_REVENUE_KEYS.join(", ")} " \
+                         "but was #{@revenue.inspect}"
+              )
+            end
+          else
+            errors.push(revenue: "revenue must be a Hash")
+          end
+        end
+
+        if present?(@props) && !@props.is_a?(Hash)
+          errors.push(props: "props must be a Hash")
+        end
+
+        errors
+      end
+
+      private
+
+      def valid_revenue_keys?(revenue)
+        revenue.keys.sort.map(&:to_sym) == VALID_REVENUE_KEYS.sort
+      end
+
+      def present?(value)
+        !value.nil? && !value.empty?
+      end
+
+      def blank?(value)
+        !present?(value)
+      end
+
+      def presence(value)
+        return nil if blank?(value)
+        value
+      end
+    end
+  end
+end

data/lib/plausible_api/stats/aggregate.rb

@@ -6,7 +6,7 @@ module PlausibleApi
 
       def initialize(options = {})
         super({ period: '30d', 
-                metrics: 'visitors,pageviews,bounce_rate,visit_duration' }
+                metrics: 'visitors,visits,pageviews,views_per_visit,bounce_rate,visit_duration,events' }
               .merge(options))
       end
       
@@ -19,4 +19,4 @@ module PlausibleApi
       end
     end
   end
-end
+end

data/lib/plausible_api/stats/base.rb

@@ -15,11 +15,31 @@ module PlausibleApi
         raise NotImplementedError
       end
 
+      def request_class
+        Net::HTTP::Get
+      end
+
+      def request_body?
+        false
+      end
+
+      def request_body
+        nil
+      end
+
       def request_url
         params = @options.select{ |_,v| !v.to_s.empty? }
         [request_url_base, URI.encode_www_form(params)].reject{|e| e.empty?}.join('&')
       end
 
+      def request_headers
+        {}
+      end
+
+      def request_auth?
+        true
+      end
+
       def parse_response(body)
         raise NotImplementedError
       end
@@ -30,7 +50,7 @@ module PlausibleApi
 
       def errors
         allowed_period   = %w(12mo 6mo month 30d 7d day custom)
-        allowed_metrics  = %w(visitors pageviews bounce_rate visit_duration)
+        allowed_metrics  = %w(visitors visits pageviews views_per_visit bounce_rate visit_duration events)
         allowed_compare  = %w(previous_period)
         allowed_interval = %w(date month)
         allowed_property = %w(event:page visit:entry_page visit:exit_page visit:source visit:referrer

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = "0.1.9"
+  VERSION = "0.2"
 end

data/lib/plausible_api.rb

@@ -1,5 +1,5 @@
-require 'plausible_api/version'
-require 'plausible_api/client'
+require "plausible_api/version"
+require "plausible_api/client"
 
 module PlausibleApi
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: '0.2'
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2023-12-23 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the new API by Plausible
 email:
@@ -26,8 +26,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/basic.rb
+- examples/event.rb
 - lib/plausible_api.rb
 - lib/plausible_api/client.rb
+- lib/plausible_api/event/base.rb
+- lib/plausible_api/event/post.rb
 - lib/plausible_api/stats/aggregate.rb
 - lib/plausible_api/stats/base.rb
 - lib/plausible_api/stats/breakdown.rb
@@ -57,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A simple Plausible API wrapper for Rails