plausible_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 799fea9f2d094075ca64a58235d62031d0f701c62b031e7f15982bbf2595d36e
-  data.tar.gz: 2a4de4e741a1cee1858dfe132102c5a2d937a27382134b80e6a8e4ca28fa327c
+  metadata.gz: 1ab7e5d90aa275223a1b9006a563093a7ac9e7ceb0be4efdb2539a511361a15b
+  data.tar.gz: f42c1294d5a65bb6ed07043a99c8febf4f42dc88d1b722632d86af2d845dd216
 SHA512:
-  metadata.gz: 57f336396b61f956dc2814fb1de4f628d7e0070334789488d0aa2ec257aec09f4ad6ef93e6fecef490049aa6884cccc72c5b2a56277bd0567923ceb1bc8b4750
-  data.tar.gz: 635da11edc92ad2c69a6bcff7b1ea4211595c180babe00ca480450195151ec9270c1c1847067ad245dd720d5e4d2bcd833a3168fc212bf40bfde82831a5c213e
+  metadata.gz: d85ed0990813b05c2cd277e6544859bf7bfdb8875ee68c20d6d71ce62ffef1579878b6e459b35305fc825bfa20fd868c5157d24eb9114bb100b2f7ce7e1a6601
+  data.tar.gz: cb29f033d91225f2bdaa6cb908308444855d734b2fd3b146345915c593257db8689556a6d227775cd440683001756a377b770a6c36b3e248b88429fece538877

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plausible_api (0.1.0)
+    plausible_api (0.1.1)
       faraday (~> 1.0)
 
 GEM

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(site_id: 'dailytics.com', token: '123123')
+c = PlausibleApi::Client.new('dailytics.com', '123123') 
 ```
 
 ### Stats > Aggregate
@@ -19,7 +19,7 @@ You have all these options to get the aggregate stats
 # Use the default parameters (3mo period + the 4 main metrics)
 c.aggregate
 
-# Set parameters (period, metrics, filter, date)
+# Set parameters (period, metrics, filter, compare)
 c.aggregate({ period: '30d' })
 c.aggregate({ period: '30d', metrics: 'visitors,pageviews' })
 c.aggregate({ period: '30d', metrics: 'visitors,pageviews', filters: 'event:page==/order/confirmation' })
@@ -35,19 +35,21 @@ You have all these options to get the timeseries
 # Use the default parameters (3mo period)
 c.timeseries
 
-# Set parameters (period, metrics, filter, date)
+# Set parameters (period, filters, interval)
 c.timeseries({ period: '7d' })
-c.timeseries({ period: '7d', filters: 'event:page==/order/confirmation', date: '2020/02/10' })
+c.timeseries({ period: '7d', filters: 'event:page==/order/confirmation' })
 
 # You'll get something like this:
 => [{"date"=>"2021-01-11", "value"=>100}, {"date"=>"2021-01-12", "value"=>120}, {"date"=>"2021-01-13", "value"=>80}...]
 ```
 
-### Realtime >> Visitors
+### Realtime > Visitors
 
-You have a uniq way to call this data
+It's as simple as:
 ```rb
 c.realtime_visitors
+
+=> 13
 ```
 
 
@@ -59,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dailytics/plausible_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dailytics/plausible_api/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/dailytics/plausible_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dailytics/plausible_api/blob/main/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -68,4 +70,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the PlausibleApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dailytics/plausible_api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PlausibleApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dailytics/plausible_api/blob/main/CODE_OF_CONDUCT.md).

data/lib/plausible_api/client.rb

@@ -12,7 +12,7 @@ module PlausibleApi
     
     BASE_URL = 'https://plausible.io'
 
-    def initialize(site_id:, token:)
+    def initialize(site_id, token)
       @site_id = site_id.to_s
       @token   = token.to_s
     end

data/lib/plausible_api/stats/aggregate.rb

@@ -6,24 +6,16 @@ module PlausibleApi
       def initialize(options = {})
         @period  = options[:period] || '30d'
         @metrics = options[:metrics] || 'visitors,pageviews,bounce_rate,visit_duration'
-        @filters  = options[:filters]
-        @date    = options[:date]
+        @filters = options[:filters]
+        @compare = options[:compare]
       end
 
       def request_url
         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}"
-        end
+        url += "&period=#{@period}" if @period
+        url += "&metrics=#{@metrics}" if @metrics
+        url += "&filters=#{CGI.escape(@filters)}" if @filters
+        url += "&compare=#{@compare}" if @compare
         url
       end
     end

data/lib/plausible_api/stats/timeseries.rb

@@ -4,22 +4,16 @@ module PlausibleApi
   module Stats
     class Timeseries
       def initialize(options = {})
-        @period = options[:period] || '30d'
-        @filters = options[:filters]
-        @date   = options[:date]
+        @period   = options[:period] || '30d'
+        @filters  = options[:filters]
+        @interval = options[:interval]
       end
 
       def request_url
         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}"
-        end
+        url += "&period=#{@period}" if @period
+        url += "&filters=#{CGI.escape(@filters)}" if @filters
+        url += "&interval=#{@interval}" if @interval
         url
       end
     end

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday