plausible_api 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 799fea9f2d094075ca64a58235d62031d0f701c62b031e7f15982bbf2595d36e
-  data.tar.gz: 2a4de4e741a1cee1858dfe132102c5a2d937a27382134b80e6a8e4ca28fa327c
+  metadata.gz: 040cbafdc8f270ac3f2bfdcaed7501535f801e93ba1059e6b776be42258714e9
+  data.tar.gz: 9e5511a3d7bb752a1b0a89e0f4d3b405eea5a6ca56262cf684626d7cf444dafc
 SHA512:
-  metadata.gz: 57f336396b61f956dc2814fb1de4f628d7e0070334789488d0aa2ec257aec09f4ad6ef93e6fecef490049aa6884cccc72c5b2a56277bd0567923ceb1bc8b4750
-  data.tar.gz: 635da11edc92ad2c69a6bcff7b1ea4211595c180babe00ca480450195151ec9270c1c1847067ad245dd720d5e4d2bcd833a3168fc212bf40bfde82831a5c213e
+  metadata.gz: 83077cd7edeb80de8388afbea3fd85d2ba2e8068345e10df04331c6356f7dc5a7c7096da9774bfe2fa6324d76fd68ec5c80cf4c39f1dd499a39dbb8d73ba24c7
+  data.tar.gz: fc95a48bf881567cce4f126c899206e18cdfbbc0b0f3ddeba6e66f37553a12f2a77a541472005eafd3c07ddc435d70886fc95d13b751b906056d616bd5604a42

data/Gemfile.lock

@@ -1,21 +1,13 @@
 PATH
   remote: .
   specs:
-    plausible_api (0.1.0)
-      faraday (~> 1.0)
+    plausible_api (0.1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    faraday (1.3.0)
-      faraday-net_http (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday-net_http (1.0.1)
     minitest (5.14.3)
-    multipart-post (2.1.1)
     rake (12.3.3)
-    ruby2_keywords (0.0.4)
 
 PLATFORMS
   ruby

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)
 
@@ -9,7 +9,11 @@ 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') 
+
+# Test if the site and token are valid
+c.valid?
+=> true
 ```
 
 ### Stats > Aggregate
@@ -19,10 +23,11 @@ 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' })
+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}}
@@ -35,19 +40,37 @@ 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' })
+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}...]
 ```
 
-### Realtime >> Visitors
+### 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', 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
 
-You have a uniq way to call this data
+It's as simple as:
 ```rb
 c.realtime_visitors
+
+=> 13
 ```
 
 
@@ -59,7 +82,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 +91,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

@@ -1,18 +1,22 @@
 # 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 'faraday'
 require 'json'
+require "net/http"
+require "uri"
+require "cgi"
 
 module PlausibleApi
   class Client
     
     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
@@ -25,18 +29,32 @@ 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
 
+    def valid?
+      realtime_visitors.is_a? Integer
+    end
+
     private
-    def call(api)
+    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)}"
-      puts url
-      res = Faraday.get(url) do |req|
-        req.headers['Authorization'] = "Bearer #{@token}"
-      end
-      JSON.parse res.body
+      uri = URI.parse(url)
+
+      req = Net::HTTP::Get.new(uri.request_uri)
+      req.add_field('Authorization', "Bearer #{@token}")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true  
+
+      api.parse_response http.request(req).body
     end
   end
 end

data/lib/plausible_api/stats/aggregate.rb

@@ -2,29 +2,20 @@
 
 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]
-        @date    = options[: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
 
-      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
+      def parse_response(body)
+        JSON.parse body
       end
     end
   end

data/lib/plausible_api/stats/base.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Base
+
+      def initialize(options = {})
+        @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
+        raise NotImplementedError
+      end
+
+      def request_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)
+        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 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 @options[:period]
+          errors.push({ period: "#{e}#{allowed_period.join(', ')}" }) unless allowed_period.include? @options[:period]
+        end
+        if @options[:metrics]
+          metrics_array = @options[:metrics].split(',') 
+          errors.push({ metrics: "#{e}#{allowed_metrics.join(', ')}" }) unless metrics_array & allowed_metrics == metrics_array
+        end
+        if @options[:compare]
+          errors.push({ compare: "#{e}#{allowed_compare.join(', ')}" }) unless allowed_compare.include? @options[:compare]
+        end
+        if @options[:interval]
+          errors.push({ interval: "#{e}#{allowed_interval.join(', ')}" }) unless allowed_interval.include? @options[:interval]
+        end
+        if @options[:property]
+          errors.push({ property: "#{e}#{allowed_property.join(', ')}" }) unless allowed_property.include? @options[:property]
+        end
+        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 @options[:limit]
+          errors.push({ limit: "Limit param must be a positive number" }) unless @options[:limit].is_a? Integer and @options[:limit] > 0
+        end
+        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 @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
+          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,20 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Breakdown < Base
+
+      def initialize(options = {})
+        super({ period: '30d', property: 'event:page' }.merge(options))
+      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,12 +3,13 @@
 module PlausibleApi 
   module Stats
     module Realtime
-      class Visitors
-        def initialize
+      class Visitors < PlausibleApi::Stats::Base
+        def request_url_base
+          "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
         end
 
-        def request_url
-          "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
+        def parse_response(body)
+          body.to_i
         end
       end
     end

data/lib/plausible_api/stats/timeseries.rb

@@ -2,25 +2,18 @@
 
 module PlausibleApi
   module Stats
-    class Timeseries
+    class Timeseries < Base
+
       def initialize(options = {})
-        @period = options[:period] || '30d'
-        @filters = options[:filters]
-        @date   = options[:date]
+        super({ period: '30d' }.merge(options))
+      end
+      
+      def request_url_base
+        "/api/v1/stats/timeseries?site_id=$SITE_ID"
       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
+      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.0"
+  VERSION = "0.1.6"
 end

data/plausible_api.gemspec

@@ -24,6 +24,4 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_dependency 'faraday', '~> 1.0'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+date: 2021-02-25 00:00:00.000000000 Z
+dependencies: []
 description: A very humble wrapper for the new API by Plausible
 email:
 - gustavo@dailytics.com
@@ -43,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