plausible_api 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ec37015a39b48b8ef1a5ff88f98452a87c590232ee527f03591d9fe3928a8d
-  data.tar.gz: d8a7df06ccea331230058b18a900b41c850a55ca18d9e850d1cc2fbf7fa7bbcc
+  metadata.gz: 22016ef4c32d7f1d0470a619111b0134134e3c272ed62a6630f3f81184e7cd50
+  data.tar.gz: ef9f7efae941960ca78dca62b4b5f02207ddfb6ebeffb174120edcc0c14b7eec
 SHA512:
-  metadata.gz: a0ce1d1dc380b44136fc38f193e307ee7b84872e6835043c02ebe89497c702daaf404efafe855c9b11f867569c612fe260ac0f1c79c959b30359d39df192d08c
-  data.tar.gz: 0b28a11d857c1b2a9b83f5336fc833abb722e9492d602172f829c0bb12956c9aba7c426649ed01428a65f88d4c49ea421d44b09a808c639aa43c83b8453f8ada
+  metadata.gz: dfa7ec056c52894e489838410ec922d90544e80dca6525718c5c8629fa9fb9faece1fb76dd28f0fc8c6f455187ab46d5bd00e5d60ad7f7a8458c38e77ef60a5e
+  data.tar.gz: c858040b75e37e69c5d50813b78cf1ccf6708d24982ad865727adeb1a501839ed3b2a0244e8128fb99919dc97b41176c78bf870b1130be332bbfd07b27ee49bc

data/Gemfile.lock

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

data/README.md

@@ -27,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({ period: 'custom', 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}}
@@ -42,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({ period: 'custom', 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', period: 'custom', 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,6 +29,10 @@ 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
@@ -37,6 +43,8 @@ module PlausibleApi
 
     private
     def call(api)      
+      raise StandardError.new "There is some invalid parameters." unless api.valid?
+      
       url = "#{BASE_URL}#{api.request_url.gsub('$SITE_ID', @site_id)}"
       uri = URI.parse(url)
 
@@ -46,7 +54,7 @@ module PlausibleApi
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true  
 
-      JSON.parse http.request(req).body
+      api.parse_response http.request(req).body
     end
   end
 end

data/lib/plausible_api/stats/aggregate.rb

@@ -2,21 +2,22 @@
 
 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]
+        @date    = options[:date]
+        @period = 'custom' if @date
       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 request_url_base
+        "/api/v1/stats/aggregate?site_id=$SITE_ID"
+      end
+
+      def parse_response(body)
+        JSON.parse body
       end
     end
   end

data/lib/plausible_api/stats/base.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Base
+      def initialize(options = {})
+        raise NotImplementedError
+      end
+
+      def request_url_base
+        raise NotImplementedError
+      end
+
+      def request_url
+        url = request_url_base
+        url += "&period=#{@period}" if defined?(@period) && @period
+        url += "&metrics=#{@metrics}" if defined?(@metrics) && @metrics
+        url += "&filters=#{CGI.escape(@filters)}" if defined?(@filters) && @filters
+        url += "&compare=#{@compare}" if defined?(@compare) && @compare
+        url += "&interval=#{@interval}" if defined?(@interval) && @interval
+        url += "&property=#{@property}" if defined?(@property) && @property
+        url += "&limit=#{@limit}" if defined?(@limit) && @limit
+        url += "&page=#{@page}" if defined?(@page) && @page
+        url += "&date=#{@date}" if defined?(@date) && @date
+        url
+      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 event:source event:referrer event:utm_medium 
+          event:utm_source event:utm_campaign event:device event:browser event:browser_version 
+          event:os event:os_version event:country)
+        e = 'Not a valid parameter. Allowed parameters are: '
+        
+        errors = []
+        if defined?(@period) && @period
+          errors.push({ period: "#{e}#{allowed_period.join(', ')}" }) unless allowed_period.include? @period
+        end
+        if defined?(@metrics) && @metrics
+          metrics_array = @metrics.split(',') 
+          errors.push({ metrics: "#{e}#{allowed_metrics.join(', ')}" }) unless metrics_array & allowed_metrics == metrics_array
+        end
+        if defined?(@compare) && @compare
+          errors.push({ compare: "#{e}#{allowed_compare.join(', ')}" }) unless allowed_compare.include? @compare
+        end
+        if defined?(@interval) && @interval
+          errors.push({ interval: "#{e}#{allowed_interval.join(', ')}" }) unless allowed_interval.include? @interval
+        end
+        if defined?(@property) && @property
+          errors.push({ property: "#{e}#{allowed_property.join(', ')}" }) unless allowed_property.include? @property
+        end
+        if defined?(@filters) && @filters
+          filters_array = @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 defined?(@limit) && @limit
+          errors.push({ limit: "Limit param must be a positive number" }) unless @limit.is_a? Integer and @limit > 0
+        end
+        if defined?(@page) && @page
+          errors.push({ page: "Page param must be a positive number" }) unless @page.is_a? Integer and @page > 0
+        end
+        if defined?(@date) && @date
+          errors.push({ date: 'You must define the period parameter as custom' }) unless @period == 'custom'
+          date_array = @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,27 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Breakdown < Base
+      def initialize(options = {})
+        @property = options[:property] || 'event:page' # required
+        @period   = options[:period] || '30d' # required
+        @metrics  = options[:metrics]
+        @limit    = options[:limit]
+        @page     = options[:page]
+        @filters  = options[:filters]
+        @date     = options[:date]
+        @period = 'custom' if @date
+        
+      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,13 +3,17 @@
 module PlausibleApi 
   module Stats
     module Realtime
-      class Visitors
+      class Visitors < PlausibleApi::Stats::Base
         def initialize
         end
 
-        def request_url
+        def request_url_base
           "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
         end
+
+        def parse_response(body)
+          body.to_i
+        end
       end
     end
   end

data/lib/plausible_api/stats/timeseries.rb

@@ -2,19 +2,21 @@
 
 module PlausibleApi
   module Stats
-    class Timeseries
+    class Timeseries < Base
       def initialize(options = {})
         @period   = options[:period] || '30d'
         @filters  = options[:filters]
         @interval = options[:interval]
+        @date     = options[:date]
+        @period = 'custom' if @date
       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 request_url_base
+        "/api/v1/stats/timeseries?site_id=$SITE_ID"
+      end
+
+      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.3"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-02-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