plausible_api 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77c960fb14e022fa7f1ae47a7c38903325d188d98c67ac598977812326b616be
-  data.tar.gz: 4d0ed7d883293c49bfb518d544efbad968b544d249cb0bfc05ff5366c87a325e
+  metadata.gz: 3164447cd3eac3c7a7cbf0c7e7cccd36eaf2bd195966283fc0da4ad023b7b21e
+  data.tar.gz: 34acbb3e21f80bd3537d4273b6555dea0da7e4fdb5cf3dcbf8bede5d477e8ce0
 SHA512:
-  metadata.gz: 6247be2a8f503c75bbff787771f1189598426171275122b6dddcc6581354db6ea3e2f81dd5c0ccc247c92ab7587f5f00c32ccc3d83b050ab70ff1470866bbbcb
-  data.tar.gz: 395a7b263fcfb9ce374f7e2d734a3d2ed608fd11755c4a6087fabc89a299da084fe5411063707e7066371660c1784ca2fa900d434d0daaefe8f00c398974dd7e
+  metadata.gz: 03273d140652347b6b282d94ff0c6294746fc7bd410dcaa1feab54a627d80ed64fa8eb1c9c56c0a3a0e3e2a95cb9cda755501987f46a3b795cb9dc2862aa1e01
+  data.tar.gz: b6e84673b3763918a28488c717e3be089107571ecb1b357b4d7e2b1ded589b68eade9d65f615e70a6655b4571a73c7bf767a0af3363b6ca90631cd0810ea91e8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plausible_api (0.2)
+    plausible_api (0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -87,6 +87,18 @@ c.event({
 })
 ```
 
+
+### Self-hosted Plausible instances
+
+If you are using a self-hosted Plausible instance, you can set the `base_url` before initializing the client. On a Ruby on Rails app, you can add this to an initializer like `config/initializers/plausible.rb`
+
+```rb
+# Do not include a trailing slash
+PlausibleApi.configure do |config|
+  config.base_url = "https://your-plausible-instance.com"
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/plausible_api/client.rb

@@ -15,8 +15,6 @@ require "cgi"
 
 module PlausibleApi
   class Client
-    BASE_URL = "https://plausible.io"
-
     def initialize(site_id, token)
       @site_id = site_id.to_s
       @token = token.to_s
@@ -54,9 +52,10 @@ module PlausibleApi
     SUCCESS_CODES = %w[200 202].freeze
 
     def call(api)
-      raise StandardError.new api.errors unless api.valid?
+      raise Error, api.errors unless api.valid?
+      raise ConfigurationError, PlausibleApi.configuration.errors unless PlausibleApi.configuration.valid?
 
-      url = "#{BASE_URL}#{api.request_url.gsub("$SITE_ID", @site_id)}"
+      url = "#{PlausibleApi.configuration.base_url}#{api.request_url.gsub("$SITE_ID", @site_id)}"
       uri = URI.parse(url)
 
       req = api.request_class.new(uri.request_uri)

data/lib/plausible_api/configuration.rb

@@ -0,0 +1,26 @@
+module PlausibleApi
+  class Configuration
+    attr_accessor :base_url
+
+    # Setting up default values
+    def initialize
+      @base_url = "https://plausible.io"
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      errors = []
+      if base_url.nil? || base_url.empty?
+        errors.push(base_url: "base_url is required")
+      elsif !(URI.parse base_url).is_a? URI::HTTP
+        errors.push(base_url: "base_url is not a valid URL")
+      elsif base_url.end_with?("/")
+        errors.push(base_url: "base_url should not end with a trailing slash")
+      end
+      errors
+    end
+  end
+end

data/lib/plausible_api/stats/aggregate.rb

@@ -5,11 +5,11 @@ module PlausibleApi
     class Aggregate < Base
 
       def initialize(options = {})
-        super({ period: '30d', 
+        super({ period: '30d',
                 metrics: 'visitors,visits,pageviews,views_per_visit,bounce_rate,visit_duration,events' }
               .merge(options))
       end
-      
+
       def request_url_base
         "/api/v1/stats/aggregate?site_id=$SITE_ID"
       end

data/lib/plausible_api/stats/breakdown.rb

@@ -7,7 +7,7 @@ module PlausibleApi
       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
@@ -17,4 +17,4 @@ module PlausibleApi
       end
     end
   end
-end
+end

data/lib/plausible_api/stats/timeseries.rb

@@ -7,7 +7,7 @@ module PlausibleApi
       def initialize(options = {})
         super({ period: '30d' }.merge(options))
       end
-      
+
       def request_url_base
         "/api/v1/stats/timeseries?site_id=$SITE_ID"
       end
@@ -17,4 +17,4 @@ module PlausibleApi
       end
     end
   end
-end
+end

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/lib/plausible_api.rb

@@ -1,7 +1,20 @@
 require "plausible_api/version"
 require "plausible_api/client"
+require "plausible_api/configuration"
 
 module PlausibleApi
   class Error < StandardError; end
+
+  class ConfigurationError < StandardError; end
+
   # Your code goes here...
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-23 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the new API by Plausible
 email:
@@ -30,6 +30,7 @@ files:
 - examples/event.rb
 - lib/plausible_api.rb
 - lib/plausible_api/client.rb
+- lib/plausible_api/configuration.rb
 - lib/plausible_api/event/base.rb
 - lib/plausible_api/event/post.rb
 - lib/plausible_api/stats/aggregate.rb