plausible_api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22016ef4c32d7f1d0470a619111b0134134e3c272ed62a6630f3f81184e7cd50
-  data.tar.gz: ef9f7efae941960ca78dca62b4b5f02207ddfb6ebeffb174120edcc0c14b7eec
+  metadata.gz: 040cbafdc8f270ac3f2bfdcaed7501535f801e93ba1059e6b776be42258714e9
+  data.tar.gz: 9e5511a3d7bb752a1b0a89e0f4d3b405eea5a6ca56262cf684626d7cf444dafc
 SHA512:
-  metadata.gz: dfa7ec056c52894e489838410ec922d90544e80dca6525718c5c8629fa9fb9faece1fb76dd28f0fc8c6f455187ab46d5bd00e5d60ad7f7a8458c38e77ef60a5e
-  data.tar.gz: c858040b75e37e69c5d50813b78cf1ccf6708d24982ad865727adeb1a501839ed3b2a0244e8128fb99919dc97b41176c78bf870b1130be332bbfd07b27ee49bc
+  metadata.gz: 83077cd7edeb80de8388afbea3fd85d2ba2e8068345e10df04331c6356f7dc5a7c7096da9774bfe2fa6324d76fd68ec5c80cf4c39f1dd499a39dbb8d73ba24c7
+  data.tar.gz: fc95a48bf881567cce4f126c899206e18cdfbbc0b0f3ddeba6e66f37553a12f2a77a541472005eafd3c07ddc435d70886fc95d13b751b906056d616bd5604a42

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plausible_api (0.1.5)
+    plausible_api (0.1.6)
 
 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)
 
@@ -27,7 +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' })
+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}}
@@ -43,7 +43,7 @@ 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' })
+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}...]
@@ -58,7 +58,7 @@ c.breakdown
 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' })
+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}]

data/lib/plausible_api/stats/aggregate.rb

@@ -3,15 +3,13 @@
 module PlausibleApi
   module Stats
     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
+        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

data/lib/plausible_api/stats/base.rb

@@ -3,8 +3,12 @@
 module PlausibleApi
   module Stats
     class Base
+
       def initialize(options = {})
-        raise NotImplementedError
+        @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
@@ -12,17 +16,8 @@ module PlausibleApi
       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
+        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)
@@ -38,45 +33,45 @@ module PlausibleApi
         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)
+        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 defined?(@period) && @period
-          errors.push({ period: "#{e}#{allowed_period.join(', ')}" }) unless allowed_period.include? @period
+        if @options[:period]
+          errors.push({ period: "#{e}#{allowed_period.join(', ')}" }) unless allowed_period.include? @options[:period]
         end
-        if defined?(@metrics) && @metrics
-          metrics_array = @metrics.split(',') 
+        if @options[:metrics]
+          metrics_array = @options[: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
+        if @options[:compare]
+          errors.push({ compare: "#{e}#{allowed_compare.join(', ')}" }) unless allowed_compare.include? @options[:compare]
         end
-        if defined?(@interval) && @interval
-          errors.push({ interval: "#{e}#{allowed_interval.join(', ')}" }) unless allowed_interval.include? @interval
+        if @options[:interval]
+          errors.push({ interval: "#{e}#{allowed_interval.join(', ')}" }) unless allowed_interval.include? @options[:interval]
         end
-        if defined?(@property) && @property
-          errors.push({ property: "#{e}#{allowed_property.join(', ')}" }) unless allowed_property.include? @property
+        if @options[:property]
+          errors.push({ property: "#{e}#{allowed_property.join(', ')}" }) unless allowed_property.include? @options[:property]
         end
-        if defined?(@filters) && @filters
-          filters_array = @filters.to_s.split(';')
+        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 defined?(@limit) && @limit
-          errors.push({ limit: "Limit param must be a positive number" }) unless @limit.is_a? Integer and @limit > 0
+        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 defined?(@page) && @page
-          errors.push({ page: "Page param must be a positive number" }) unless @page.is_a? Integer and @page > 0
+        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 defined?(@date) && @date
-          errors.push({ date: 'You must define the period parameter as custom' }) unless @period == 'custom'
-          date_array = @date.split(",")
+        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

data/lib/plausible_api/stats/breakdown.rb

@@ -3,18 +3,11 @@
 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
-        
+        super({ period: '30d', property: 'event:page' }.merge(options))
       end
-
+      
       def request_url_base
         "/api/v1/stats/breakdown?site_id=$SITE_ID"
       end

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

@@ -4,9 +4,6 @@ module PlausibleApi
   module Stats
     module Realtime
       class Visitors < PlausibleApi::Stats::Base
-        def initialize
-        end
-
         def request_url_base
           "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
         end

data/lib/plausible_api/stats/timeseries.rb

@@ -3,14 +3,11 @@
 module PlausibleApi
   module Stats
     class Timeseries < Base
+
       def initialize(options = {})
-        @period   = options[:period] || '30d'
-        @filters  = options[:filters]
-        @interval = options[:interval]
-        @date     = options[:date]
-        @period = 'custom' if @date
+        super({ period: '30d' }.merge(options))
       end
-
+      
       def request_url_base
         "/api/v1/stats/timeseries?site_id=$SITE_ID"
       end

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the new API by Plausible
 email: