plausible_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be1224dad0283128a3e21c2d4e53061845ddc2424e2a89655eb4a129925cb4d
-  data.tar.gz: b665e6e0dea74c2fe9e1f1309a418cbfe2a5f9be55a4ac0f14845ba6a207fc70
+  metadata.gz: 3960123efcdafae0607d993403d5d3ed6108952b623e282e08d97abe5d68b337
+  data.tar.gz: 7c03a6435a1d62ca54c07969e09141a546014b093b5ac6e1150b33031f0bdbbf
 SHA512:
-  metadata.gz: 645bd976b0dc10c743232daa6752bee9bb5d9e29ee96235ac0d6efa541ffa1d3fe8e3518e510701de377dd3621e44a4c9b0c54cb99a7b50ffe8b85879036ce8c
-  data.tar.gz: 312e92ef37577f2e58e7ffabf72320bc8c9fc431c651779f0ccd2d264d0aa144e08a10ac8a4c71375ceaed5a17d0814b7d36e8d4446cbcc41278d7b775f3d43b
+  metadata.gz: 5b6330d478c5affc54605998832e32d38f72659099279f40cb550a84eda0c0593b61efe0af7c7b0ff581e93ed2c191c47518a9eb6d9fee73fb68617372d85f1f
+  data.tar.gz: 53a8202c35ce4507e6144ffb3623ef899822b179b11b716ec60a079aefbbb2fea89d0be1c4e31e6b625c8540dfb5a1160d81224d2a06af9b31d848e422743830

data/README.md

@@ -20,9 +20,9 @@ You have all these options to get the aggregate stats
 c.aggregate
 
 # Set parameters (period, metrics, filter, date)
-c.aggregate({ period: '3d' })
-c.aggregate({ period: '3d', metrics: 'visitors,pageviews' })
-c.aggregate({ period: '3d', metrics: 'visitors,pageviews', filter: 'event:page==/order/confirmation' })
+c.aggregate({ period: '30d' })
+c.aggregate({ period: '30d', metrics: 'visitors,pageviews' })
+c.aggregate({ period: '30d', metrics: 'visitors,pageviews', filters: 'event:page==/order/confirmation' })
 
 # You'll get something like this:
 => {"bounce_rate"=>{"value"=>81.0}, "pageviews"=>{"value"=>29}, "visit_duration"=>{"value"=>247.0}, "visitors"=>{"value"=>14}}
@@ -36,11 +36,11 @@ You have all these options to get the timeseries
 c.timeseries
 
 # Set parameters (period, metrics, filter, date)
-c.timeseries({ period: '3d' })
-c.timeseries({ period: '3d', filter: 'event:page==/order/confirmation', date: '2020/02/10' })
+c.timeseries({ period: '7d' })
+c.timeseries({ period: '7d', filters: 'event:page==/order/confirmation', date: '2020/02/10' })
 
 # You'll get something like this:
-=> [{"date"=>"2021-01-11", "value"=>100}, {"date"=>"2021-01-12", "value"=>120}, {"date"=>"2021-01-13", "value"=>80}]
+=> [{"date"=>"2021-01-11", "value"=>100}, {"date"=>"2021-01-12", "value"=>120}, {"date"=>"2021-01-13", "value"=>80}...]
 ```
 
 ### Realtime >> Visitors
@@ -56,9 +56,8 @@ $ gem build plausible_api.gemspec
 $ gem install ./plausible_api-X.X.X.gem
 $ irb
 irb(main) > require 'plausible_api'
-irb(main) > c = PlausibleApi::Client.new(site_id: 'dailytics.com', token: '123123')
-irb(main) > c.aggregate(period: '1w', metrics: 'visitors,pageviews,bounce_rate,visit_duration')
 ```
 
 ## Todo
-- Tests
+- Tests
+- Options validation

data/lib/plausible_api/api/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'plausible_api/api/realtime/visitors'
+require 'plausible_api/api/stats/realtime/visitors'
 require 'plausible_api/api/stats/aggregate'
 require 'plausible_api/api/stats/timeseries'
 
@@ -26,7 +26,7 @@ module PlausibleApi
     end
 
     def realtime_visitors
-      call PlausibleApi::Realtime::Visitors.new
+      call PlausibleApi::Stats::Realtime::Visitors.new
     end
 
     private

data/lib/plausible_api/api/stats/aggregate.rb

@@ -4,16 +4,22 @@ module PlausibleApi
   module Stats
     class Aggregate
       def initialize(options = {})
-        @period  = options[:period] || '3mo'
+        @period  = options[:period] || '30d'
         @metrics = options[:metrics] || 'visitors,pageviews,bounce_rate,visit_duration'
-        @filter  = options[:filter]
+        @filters  = options[:filters]
         @date    = options[:date]
       end
 
       def request_url
-        url = "/api/v1/stats/aggregate?site_id=$SITE_ID&period=#{@period}&metrics=#{@metrics}"
-        if @filter
-          url += "&filter=#{CGI.escape(@filter)}"
+        url = "/api/v1/stats/aggregate?site_id=$SITE_ID"
+        if @period
+          url += "&period=#{@period}"
+        end
+        if @metrics
+          url += "&metrics=#{@metrics}"
+        end
+        if @filters
+          url += "&filters=#{CGI.escape(@filters)}"
         end
         if @date
           url += "&date=#{@date}"

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PlausibleApi 
+  module Stats
+    module Realtime
+      class Visitors
+        def initialize
+        end
+
+        def request_url
+          "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
+        end
+      end
+    end
+  end
+end

data/lib/plausible_api/api/stats/timeseries.rb

@@ -4,15 +4,18 @@ module PlausibleApi
   module Stats
     class Timeseries
       def initialize(options = {})
-        @period = options[:period] || '3mo'
-        @filter = options[:filter]
+        @period = options[:period] || '30d'
+        @filters = options[:filters]
         @date   = options[:date]
       end
 
       def request_url
-        url = "/api/v1/stats/timeseries?site_id=$SITE_ID&period=#{@period}"
-        if @filter
-          url += "&filter=#{CGI.escape(@filter)}"
+        url = "/api/v1/stats/timeseries?site_id=$SITE_ID"
+        if @period
+          url += "&period=#{@period}"
+        end
+        if @filters
+          url += "&filters=#{CGI.escape(@filters)}"
         end
         if @date
           url += "&date=#{@date}"

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gustavo Garcia
@@ -34,8 +34,8 @@ files:
 - README.md
 - lib/plausible_api.rb
 - lib/plausible_api/api/client.rb
-- lib/plausible_api/api/realtime/visitors.rb
 - lib/plausible_api/api/stats/aggregate.rb
+- lib/plausible_api/api/stats/realtime/visitors.rb
 - lib/plausible_api/api/stats/timeseries.rb
 - lib/plausible_api/version.rb
 - plausible_api.gemspec

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module PlausibleApi 
-  module Realtime
-    class Visitors
-      def initialize
-      end
-
-      def request_url
-        "/api/v1/realtime/visitors?site_id=$SITE_ID"
-      end
-    end
-  end
-end