plausible_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b58fa3210ca9873840e437b5a892002428841db0f3f5783ebe17d908e21c4796
+  data.tar.gz: a08c015aaae05008413710e4cc7d367f15fa37385ef5db4d751d072c56255637
+SHA512:
+  metadata.gz: c794f02c31e7bedfd56b461bfc0a66ec8a106583fd71eca4ce2a8c71abce521d69088b93a73b012f8ad6201211b02462778b76d6c876d1084431214d6da1afdd
+  data.tar.gz: 27efd9f3d37cd91c2952800690b5bc5a998f38fc7ef4c40652f56b6c6d843468ef016896f8af945e0a2b11c33d8ed789e8f0f7b99a65a6fff52a8fda7d19a919

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,28 @@
+# Plausible API (Work In Progress)
+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)
+
+## Usage
+Add this gem to your Gemfile:
+```
+gem 'plausible_api'
+```
+Then you need to initialize a Client and then call one of the available stats:
+```
+c = PlausibleApi::Client.new(site_id: 'dailytics.com', token: '123123')
+c.aggregate(period: '1w', metrics: 'visitors,pageviews,bounce_rate,visit_duration')
+```
+
+## Development
+```
+$ 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
+- Add support for other endpoints
+- Tests

data/lib/plausible_api.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'plausible_api/api/client'
+
+module PlausibleApi
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stdout).tap { |log| log.progname = self.name }
+    end
+  end
+end

data/lib/plausible_api/api/client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'plausible_api/api/realtime/visitors'
+require 'plausible_api/api/stats/aggregate'
+require 'plausible_api/api/stats/timeseries'
+
+require 'faraday'
+require 'json'
+
+module PlausibleApi
+  class Client
+    
+    BASE_URL = 'https://plausible.io'
+
+    def initialize(site_id:, token:)
+      @site_id = site_id.to_s
+      @token   = token
+    end
+
+    def aggregate(period:, metrics:)
+      call PlausibleApi::Stats::Aggregate.new(period: period, metrics: metrics)
+    end
+
+    private
+    def call(resource)
+      res = Faraday.get("#{BASE_URL}/#{resource.request_url.gsub('$SITE_ID', @site_id)}") do |req|
+        req.headers['Authorization'] = "Bearer #{@token}"
+      end
+      JSON.parse res.body
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'plausible_api/request'
+
+module PlausibleApi 
+  module Realtime
+    class Visitors
+
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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'
+      end
+
+      def request_url
+        "api/v1/stats/aggregate?site_id=$SITE_ID&period=#{@period}&metrics=#{@metrics}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'plausible_api/request'
+
+module PlausibleApi
+  module Stats
+    class Timeseries
+
+    end
+  end
+end

data/lib/plausible_api/request.rb

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

data/lib/plausible_api/version.rb

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

data/plausible_api.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'plausible_api/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'plausible_api'
+  s.version       = PlausibleApi::VERSION
+  s.summary       = 'A simple Plausible API wrapper for Rails'
+  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.license       = 'MIT'
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'faraday'
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: plausible_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Garcia
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A very humble wrapper for the new API by Plausible
+email: gustavo@dailytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- 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/timeseries.rb
+- lib/plausible_api/request.rb
+- lib/plausible_api/version.rb
+- plausible_api.gemspec
+homepage: https://rubygems.org/gems/plausible_api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A simple Plausible API wrapper for Rails
+test_files: []