plausible_api 0.1.2 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e5dc3ef2295b911db3855a3dd745f9f6bfe964fd9744fca791071785dcfe10
-  data.tar.gz: 90f4ee8e828ed9318e2a990bc4f9ed928af6e828c073020a179bb656ad4538c6
+  metadata.gz: 725e6a56e5cee867b7d2440667a399d13c9310b37acb54a910cb7f26087273f3
+  data.tar.gz: eea16b022039a10cf041030efab80f610ffe010a0adbbb561ceb9180ca6b9a81
 SHA512:
-  metadata.gz: 8f76963510fbb456467cd9cca3cbfdb7100ddddf0b7aaf38848153386b5d09dd1617839416a52bf59b8cf755b829913748335826c908ed1826f496d7b164f29e
-  data.tar.gz: a0750f809ecd8982532cc8a325361a660d0152610b37dd8c34ad83179b08ea3468a8e3eac8c6c92c37e54468cbe7f55e7b74b005e346e32f9d8d16b15de3742a
+  metadata.gz: e760b16016faa8c19ec11698da4412d1432c36ab77569440cc4b532959c78489691ff238204c7e248973ce74a5d40aaaa54f7cfbfbaebaeb9e5cc28d7cebd438
+  data.tar.gz: 2e0a07adcb710d4133e44dac5cd8fa783553b1f5a8733b106f031fe63ff7a9fa6b3e22af0fdeeec13880274405f99de1417e3baf297b22d5187e8ab7eb12c78c

data/Gemfile.lock

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

data/README.md

@@ -1,4 +1,4 @@
-# Plausible API (Work In Progress)
+# Plausible API Ruby Gem
 This is a simple wrapper to read the Plausible API with Ruby.
 It's based on the WIP [API guide](https://plausible.io/docs/stats-api)
 
@@ -10,6 +10,10 @@ 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') 
+
+# Test if the site and token are valid
+c.valid?
+=> true
 ```
 
 ### Stats > Aggregate
@@ -23,6 +27,7 @@ c.aggregate
 c.aggregate({ period: '30d' })
 c.aggregate({ period: '30d', metrics: 'visitors,pageviews' })
 c.aggregate({ period: '30d', metrics: 'visitors,pageviews', filters: 'event:page==/order/confirmation' })
+c.aggregate({ date: '2021-01-01,2021-02-10' })
 
 # You'll get something like this:
 => {"bounce_rate"=>{"value"=>81.0}, "pageviews"=>{"value"=>29}, "visit_duration"=>{"value"=>247.0}, "visitors"=>{"value"=>14}}
@@ -38,11 +43,27 @@ c.timeseries
 # Set parameters (period, filters, interval)
 c.timeseries({ period: '7d' })
 c.timeseries({ period: '7d', filters: 'event:page==/order/confirmation' })
+c.timeseries({ date: '2021-01-01,2021-02-15' })
 
 # You'll get something like this:
 => [{"date"=>"2021-01-11", "value"=>100}, {"date"=>"2021-01-12", "value"=>120}, {"date"=>"2021-01-13", "value"=>80}...]
 ```
 
+### Stats > Breakdown
+```rb
+# Use the default parameters (30d, event:page)
+c.breakdown
+
+# Set parameters (property, period, metrics, limit, page, filters, date)
+c.breakdown({ property: 'visit:source' })
+c.breakdown({ property: 'visit:source', metrics: 'visitors,pageviews' })
+c.breakdown({ property: 'visit:source', metrics: 'visitors,pageviews', period: '30d' })
+c.breakdown({ property: 'visit:source', metrics: 'visitors,pageviews', date: '2021-01-01,2021-02-01' })
+
+# You'll get something like this:
+=> [{"page"=>"/", "visitors"=>41}, {"page"=>"/plans/", "visitors"=>14}, {"page"=>"/agencies/", "visitors"=>8}, {"page"=>"/features/", "visitors"=>8}, {"page"=>"/ready/", "visitors"=>5}, {"page"=>"/contact/", "visitors"=>4}, {"page"=>"/about/", "visitors"=>3}, {"page"=>"/donate/", "visitors"=>3}]
+```
+
 ### Realtime > Visitors
 
 It's as simple as:

data/lib/plausible_api/client.rb

@@ -1,8 +1,10 @@
 # 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 'json'
 require "net/http"
@@ -27,16 +29,27 @@ module PlausibleApi
       call PlausibleApi::Stats::Timeseries.new(options)
     end
 
+    def breakdown(options = {})
+      call PlausibleApi::Stats::Breakdown.new(options)
+    end
+
     def realtime_visitors
       call PlausibleApi::Stats::Realtime::Visitors.new
     end
 
-    def test
-      realtime_visitors.is_a? Integer
+    def valid?
+      begin
+        realtime_visitors
+        return true
+      rescue
+        return false
+      end
     end
 
     private
     def call(api)      
+      raise StandardError.new api.errors unless api.valid?
+      
       url = "#{BASE_URL}#{api.request_url.gsub('$SITE_ID', @site_id)}"
       uri = URI.parse(url)
 
@@ -46,7 +59,13 @@ module PlausibleApi
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true  
 
-      JSON.parse http.request(req).body
+      response = http.request(req)
+
+      if response.code == "200"
+        api.parse_response response.body
+      else
+        raise StandardError.new response.body
+      end
     end
   end
 end

data/lib/plausible_api/stats/aggregate.rb

@@ -2,21 +2,20 @@
 
 module PlausibleApi
   module Stats
-    class Aggregate
+    class Aggregate < Base
+
       def initialize(options = {})
-        @period  = options[:period] || '30d'
-        @metrics = options[:metrics] || 'visitors,pageviews,bounce_rate,visit_duration'
-        @filters = options[:filters]
-        @compare = options[:compare]
+        super({ period: '30d', 
+                metrics: 'visitors,pageviews,bounce_rate,visit_duration' }
+              .merge(options))
+      end
+      
+      def request_url_base
+        "/api/v1/stats/aggregate?site_id=$SITE_ID"
       end
 
-      def request_url
-        url = "/api/v1/stats/aggregate?site_id=$SITE_ID"
-        url += "&period=#{@period}" if @period
-        url += "&metrics=#{@metrics}" if @metrics
-        url += "&filters=#{CGI.escape(@filters)}" if @filters
-        url += "&compare=#{@compare}" if @compare
-        url
+      def parse_response(body)
+        JSON.parse(body)['results']
       end
     end
   end

data/lib/plausible_api/stats/base.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Base
+
+      def initialize(options = {})
+        @options = { compare: nil, date: nil, filters: nil, interval: nil,
+                      limit: nil, metrics: nil, page: nil, period: nil, 
+                      property: nil }.merge(options)
+        @options[:period] = 'custom' if @options[:date]
+      end
+
+      def request_url_base
+        raise NotImplementedError
+      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 parse_response(body)
+        raise NotImplementedError
+      end
+
+      def valid?
+        errors.empty?
+      end
+
+      def errors  
+        allowed_period   = %w(12mo 6mo month 30d 7d day custom)
+        allowed_metrics  = %w(visitors pageviews bounce_rate visit_duration)
+        allowed_compare  = %w(previous_period)
+        allowed_interval = %w(date month)
+        allowed_property = %w(event:page visit:source visit:referrer visit:utm_medium 
+          visit:utm_source visit:utm_campaign visit:device visit:browser visit:browser_version 
+          visit:os visit:os_version visit:country)
+        e = 'Not a valid parameter. Allowed parameters are: '
+        
+        errors = []
+        if @options[:period]
+          errors.push({ period: "#{e}#{allowed_period.join(', ')}" }) unless allowed_period.include? @options[:period]
+        end
+        if @options[:metrics]
+          metrics_array = @options[:metrics].split(',') 
+          errors.push({ metrics: "#{e}#{allowed_metrics.join(', ')}" }) unless metrics_array & allowed_metrics == metrics_array
+        end
+        if @options[:compare]
+          errors.push({ compare: "#{e}#{allowed_compare.join(', ')}" }) unless allowed_compare.include? @options[:compare]
+        end
+        if @options[:interval]
+          errors.push({ interval: "#{e}#{allowed_interval.join(', ')}" }) unless allowed_interval.include? @options[:interval]
+        end
+        if @options[:property]
+          errors.push({ property: "#{e}#{allowed_property.join(', ')}" }) unless allowed_property.include? @options[:property]
+        end
+        if @options[:filters]
+          filters_array = @options[:filters].to_s.split(';')
+          filters_array.each do |f|
+            parts = f.split("==")
+            errors.push({ filters: "Unrecognized filter: #{f}" }) unless parts.length == 2
+            errors.push({ filters: "Unknown metric for filter: #{parts[0]}" }) unless allowed_property.include? parts[0]
+          end
+        end
+        if @options[:limit]
+          errors.push({ limit: "Limit param must be a positive number" }) unless @options[:limit].is_a? Integer and @options[:limit] > 0
+        end
+        if @options[:page]
+          errors.push({ page: "Page param must be a positive number" }) unless @options[:page].is_a? Integer and @options[:page] > 0
+        end
+        if @options[:date]
+          errors.push({ date: 'You must define the period parameter as custom' }) unless @options[:period] == 'custom'
+          date_array = @options[:date].split(",")
+          errors.push({ date: 'You must define start and end dates divided by comma' }) unless date_array.length == 2
+          regex = /\d{4}\-\d{2}\-\d{2}/
+          errors.push({ date: 'Wrong format for the start date' }) unless date_array[0] =~ regex
+          errors.push({ date: 'Wrong format for the end date' }) unless date_array[1] =~ regex
+        end
+        errors
+      end
+    end
+  end
+end

data/lib/plausible_api/stats/breakdown.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Breakdown < Base
+
+      def initialize(options = {})
+        super({ period: '30d', property: 'event:page' }.merge(options))
+      end
+      
+      def request_url_base
+        "/api/v1/stats/breakdown?site_id=$SITE_ID"
+      end
+
+      def parse_response(body)
+        JSON.parse(body)['results']
+      end
+    end
+  end
+end

data/lib/plausible_api/stats/realtime/visitors.rb

@@ -3,12 +3,13 @@
 module PlausibleApi 
   module Stats
     module Realtime
-      class Visitors
-        def initialize
+      class Visitors < PlausibleApi::Stats::Base
+        def request_url_base
+          "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
         end
 
-        def request_url
-          "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
+        def parse_response(body)
+          body.to_i
         end
       end
     end

data/lib/plausible_api/stats/timeseries.rb

@@ -2,19 +2,18 @@
 
 module PlausibleApi
   module Stats
-    class Timeseries
+    class Timeseries < Base
+
       def initialize(options = {})
-        @period   = options[:period] || '30d'
-        @filters  = options[:filters]
-        @interval = options[:interval]
+        super({ period: '30d' }.merge(options))
+      end
+      
+      def request_url_base
+        "/api/v1/stats/timeseries?site_id=$SITE_ID"
       end
 
-      def request_url
-        url = "/api/v1/stats/timeseries?site_id=$SITE_ID"
-        url += "&period=#{@period}" if @period
-        url += "&filters=#{CGI.escape(@filters)}" if @filters
-        url += "&interval=#{@interval}" if @interval
-        url
+      def parse_response(body)
+        JSON.parse(body)['results']
       end
     end
   end

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = "0.1.2"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.8
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the new API by Plausible
 email:
@@ -29,6 +29,8 @@ files:
 - lib/plausible_api.rb
 - lib/plausible_api/client.rb
 - lib/plausible_api/stats/aggregate.rb
+- lib/plausible_api/stats/base.rb
+- lib/plausible_api/stats/breakdown.rb
 - lib/plausible_api/stats/realtime/visitors.rb
 - lib/plausible_api/stats/timeseries.rb
 - lib/plausible_api/version.rb