plausible_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b58fa3210ca9873840e437b5a892002428841db0f3f5783ebe17d908e21c4796
-  data.tar.gz: a08c015aaae05008413710e4cc7d367f15fa37385ef5db4d751d072c56255637
+  metadata.gz: 8be1224dad0283128a3e21c2d4e53061845ddc2424e2a89655eb4a129925cb4d
+  data.tar.gz: b665e6e0dea74c2fe9e1f1309a418cbfe2a5f9be55a4ac0f14845ba6a207fc70
 SHA512:
-  metadata.gz: c794f02c31e7bedfd56b461bfc0a66ec8a106583fd71eca4ce2a8c71abce521d69088b93a73b012f8ad6201211b02462778b76d6c876d1084431214d6da1afdd
-  data.tar.gz: 27efd9f3d37cd91c2952800690b5bc5a998f38fc7ef4c40652f56b6c6d843468ef016896f8af945e0a2b11c33d8ed789e8f0f7b99a65a6fff52a8fda7d19a919
+  metadata.gz: 645bd976b0dc10c743232daa6752bee9bb5d9e29ee96235ac0d6efa541ffa1d3fe8e3518e510701de377dd3621e44a4c9b0c54cb99a7b50ffe8b85879036ce8c
+  data.tar.gz: 312e92ef37577f2e58e7ffabf72320bc8c9fc431c651779f0ccd2d264d0aa144e08a10ac8a4c71375ceaed5a17d0814b7d36e8d4446cbcc41278d7b775f3d43b

data/README.md

@@ -4,13 +4,50 @@ It's based on the WIP [API guide](https://plausible.io/docs/stats-api)
 
 ## Usage
 Add this gem to your Gemfile:
-```
+```rb
 gem 'plausible_api'
 ```
-Then you need to initialize a Client and then call one of the available stats:
-```
+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.aggregate(period: '1w', metrics: 'visitors,pageviews,bounce_rate,visit_duration')
+```
+
+### Stats > Aggregate
+
+You have all these options to get the aggregate stats
+```rb
+# Use the default parameters (3mo period + the 4 main metrics)
+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' })
+
+# You'll get something like this:
+=> {"bounce_rate"=>{"value"=>81.0}, "pageviews"=>{"value"=>29}, "visit_duration"=>{"value"=>247.0}, "visitors"=>{"value"=>14}}
+```
+
+### Stats > Timeseries
+
+You have all these options to get the timeseries
+```rb
+# Use the default parameters (3mo period)
+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' })
+
+# 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
+
+You have a uniq way to call this data
+```rb
+c.realtime_visitors
 ```
 
 ## Development
@@ -24,5 +61,4 @@ irb(main) > c.aggregate(period: '1w', metrics: 'visitors,pageviews,bounce_rate,v
 ```
 
 ## Todo
-- Add support for other endpoints
 - Tests

data/lib/plausible_api/api/client.rb

@@ -14,16 +14,26 @@ module PlausibleApi
 
     def initialize(site_id:, token:)
       @site_id = site_id.to_s
-      @token   = token
+      @token   = token.to_s
     end
 
-    def aggregate(period:, metrics:)
-      call PlausibleApi::Stats::Aggregate.new(period: period, metrics: metrics)
+    def aggregate(options = {})
+      call PlausibleApi::Stats::Aggregate.new(options)
+    end
+
+    def timeseries(options = {})
+      call PlausibleApi::Stats::Timeseries.new(options)
+    end
+
+    def realtime_visitors
+      call PlausibleApi::Realtime::Visitors.new
     end
 
     private
-    def call(resource)
-      res = Faraday.get("#{BASE_URL}/#{resource.request_url.gsub('$SITE_ID', @site_id)}") do |req|
+    def call(api)
+      url = "#{BASE_URL}#{api.request_url.gsub('$SITE_ID', @site_id)}"
+      puts url
+      res = Faraday.get(url) do |req|
         req.headers['Authorization'] = "Bearer #{@token}"
       end
       JSON.parse res.body

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

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

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

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
-require 'plausible_api/request'
-
 module PlausibleApi
   module Stats
     class Aggregate
-
-      def initialize(period: nil, metrics: nil)
-        @period  = period || '3m'
-        @metrics = metrics || 'visitors,pageviews,bounce_rate,visit_duration'
+      def initialize(options = {})
+        @period  = options[:period] || '3mo'
+        @metrics = options[:metrics] || 'visitors,pageviews,bounce_rate,visit_duration'
+        @filter  = options[:filter]
+        @date    = options[:date]
       end
 
       def request_url
-        "api/v1/stats/aggregate?site_id=$SITE_ID&period=#{@period}&metrics=#{@metrics}"
+        url = "/api/v1/stats/aggregate?site_id=$SITE_ID&period=#{@period}&metrics=#{@metrics}"
+        if @filter
+          url += "&filter=#{CGI.escape(@filter)}"
+        end
+        if @date
+          url += "&date=#{@date}"
+        end
+        url
       end
     end
   end

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

@@ -1,11 +1,24 @@
 # frozen_string_literal: true
 
-require 'plausible_api/request'
-
 module PlausibleApi
   module Stats
     class Timeseries
+      def initialize(options = {})
+        @period = options[:period] || '3mo'
+        @filter = options[:filter]
+        @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)}"
+        end
+        if @date
+          url += "&date=#{@date}"
+        end
+        url
+      end
     end
   end
 end

data/lib/plausible_api/version.rb

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

data/plausible_api.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |s|
   s.description   = 'A very humble wrapper for the new API by Plausible'
   s.authors       = ['Gustavo Garcia']
   s.email         = 'gustavo@dailytics.com'
-  s.homepage      = 'https://rubygems.org/gems/plausible_api'
+  s.homepage      = 'https://github.com/dailytics/plausible-api'
   s.license       = 'MIT'
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'faraday'
+  s.add_dependency 'faraday', '~> 1.0'
+  s.required_ruby_version = '>= 2.4'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: A very humble wrapper for the new API by Plausible
 email: gustavo@dailytics.com
 executables: []
@@ -37,10 +37,9 @@ files:
 - lib/plausible_api/api/realtime/visitors.rb
 - lib/plausible_api/api/stats/aggregate.rb
 - lib/plausible_api/api/stats/timeseries.rb
-- lib/plausible_api/request.rb
 - lib/plausible_api/version.rb
 - plausible_api.gemspec
-homepage: https://rubygems.org/gems/plausible_api
+homepage: https://github.com/dailytics/plausible-api
 licenses:
 - MIT
 metadata: {}
@@ -52,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/plausible_api/request.rb

@@ -1,5 +0,0 @@
-module PlausibleApi
-  class Request
-
-  end
-end