plausible_api 0.0.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3960123efcdafae0607d993403d5d3ed6108952b623e282e08d97abe5d68b337
-  data.tar.gz: 7c03a6435a1d62ca54c07969e09141a546014b093b5ac6e1150b33031f0bdbbf
+  metadata.gz: 22016ef4c32d7f1d0470a619111b0134134e3c272ed62a6630f3f81184e7cd50
+  data.tar.gz: ef9f7efae941960ca78dca62b4b5f02207ddfb6ebeffb174120edcc0c14b7eec
 SHA512:
-  metadata.gz: 5b6330d478c5affc54605998832e32d38f72659099279f40cb550a84eda0c0593b61efe0af7c7b0ff581e93ed2c191c47518a9eb6d9fee73fb68617372d85f1f
-  data.tar.gz: 53a8202c35ce4507e6144ffb3623ef899822b179b11b716ec60a079aefbbb2fea89d0be1c4e31e6b625c8540dfb5a1160d81224d2a06af9b31d848e422743830
+  metadata.gz: dfa7ec056c52894e489838410ec922d90544e80dca6525718c5c8629fa9fb9faece1fb76dd28f0fc8c6f455187ab46d5bd00e5d60ad7f7a8458c38e77ef60a5e
+  data.tar.gz: c858040b75e37e69c5d50813b78cf1ccf6708d24982ad865727adeb1a501839ed3b2a0244e8128fb99919dc97b41176c78bf870b1130be332bbfd07b27ee49bc

data/.gitignore

@@ -1 +1,9 @@
-*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at luctus@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in plausible_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    plausible_api (0.1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.3)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  plausible_api!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Gustavo Garcia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -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({ period: 'custom', 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,29 +40,55 @@ 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({ period: 'custom', 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', period: 'custom', 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
 ```
 
+
 ## Development
-```
-$ gem build plausible_api.gemspec 
-$ gem install ./plausible_api-X.X.X.gem
-$ irb
-irb(main) > require 'plausible_api'
-```
 
-## Todo
-- Tests
-- Options validation
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plausible_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/plausible_api.rb

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

data/lib/plausible_api/client.rb

@@ -0,0 +1,60 @@
+# 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 'json'
+require "net/http"
+require "uri"
+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
+    end
+
+    def aggregate(options = {})
+      call PlausibleApi::Stats::Aggregate.new(options)
+    end
+
+    def timeseries(options = {})
+      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)      
+      raise StandardError.new "There is some invalid parameters." unless api.valid?
+      
+      url = "#{BASE_URL}#{api.request_url.gsub('$SITE_ID', @site_id)}"
+      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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Aggregate < Base
+      def initialize(options = {})
+        @period  = options[:period] || '30d'
+        @metrics = options[:metrics] || 'visitors,pageviews,bounce_rate,visit_duration'
+        @filters = options[:filters]
+        @compare = options[:compare]
+        @date    = options[:date]
+        @period = 'custom' if @date
+      end
+
+      def request_url_base
+        "/api/v1/stats/aggregate?site_id=$SITE_ID"
+      end
+
+      def parse_response(body)
+        JSON.parse body
+      end
+    end
+  end
+end

data/lib/plausible_api/stats/base.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Base
+      def initialize(options = {})
+        raise NotImplementedError
+      end
+
+      def request_url_base
+        raise NotImplementedError
+      end
+
+      def request_url
+        url = request_url_base
+        url += "&period=#{@period}" if defined?(@period) && @period
+        url += "&metrics=#{@metrics}" if defined?(@metrics) && @metrics
+        url += "&filters=#{CGI.escape(@filters)}" if defined?(@filters) && @filters
+        url += "&compare=#{@compare}" if defined?(@compare) && @compare
+        url += "&interval=#{@interval}" if defined?(@interval) && @interval
+        url += "&property=#{@property}" if defined?(@property) && @property
+        url += "&limit=#{@limit}" if defined?(@limit) && @limit
+        url += "&page=#{@page}" if defined?(@page) && @page
+        url += "&date=#{@date}" if defined?(@date) && @date
+        url
+      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 event:source event:referrer event:utm_medium 
+          event:utm_source event:utm_campaign event:device event:browser event:browser_version 
+          event:os event:os_version event:country)
+        e = 'Not a valid parameter. Allowed parameters are: '
+        
+        errors = []
+        if defined?(@period) && @period
+          errors.push({ period: "#{e}#{allowed_period.join(', ')}" }) unless allowed_period.include? @period
+        end
+        if defined?(@metrics) && @metrics
+          metrics_array = @metrics.split(',') 
+          errors.push({ metrics: "#{e}#{allowed_metrics.join(', ')}" }) unless metrics_array & allowed_metrics == metrics_array
+        end
+        if defined?(@compare) && @compare
+          errors.push({ compare: "#{e}#{allowed_compare.join(', ')}" }) unless allowed_compare.include? @compare
+        end
+        if defined?(@interval) && @interval
+          errors.push({ interval: "#{e}#{allowed_interval.join(', ')}" }) unless allowed_interval.include? @interval
+        end
+        if defined?(@property) && @property
+          errors.push({ property: "#{e}#{allowed_property.join(', ')}" }) unless allowed_property.include? @property
+        end
+        if defined?(@filters) && @filters
+          filters_array = @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 defined?(@limit) && @limit
+          errors.push({ limit: "Limit param must be a positive number" }) unless @limit.is_a? Integer and @limit > 0
+        end
+        if defined?(@page) && @page
+          errors.push({ page: "Page param must be a positive number" }) unless @page.is_a? Integer and @page > 0
+        end
+        if defined?(@date) && @date
+          errors.push({ date: 'You must define the period parameter as custom' }) unless @period == 'custom'
+          date_array = @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,27 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Breakdown < Base
+      def initialize(options = {})
+        @property = options[:property] || 'event:page' # required
+        @period   = options[:period] || '30d' # required
+        @metrics  = options[:metrics]
+        @limit    = options[:limit]
+        @page     = options[:page]
+        @filters  = options[:filters]
+        @date     = options[:date]
+        @period = 'custom' if @date
+        
+      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/{api/stats → stats}/realtime/visitors.rb

@@ -3,13 +3,17 @@
 module PlausibleApi 
   module Stats
     module Realtime
-      class Visitors
+      class Visitors < PlausibleApi::Stats::Base
         def initialize
         end
 
-        def request_url
+        def request_url_base
           "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
         end
+
+        def parse_response(body)
+          body.to_i
+        end
       end
     end
   end

data/lib/plausible_api/stats/timeseries.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Timeseries < Base
+      def initialize(options = {})
+        @period   = options[:period] || '30d'
+        @filters  = options[:filters]
+        @interval = options[:interval]
+        @date     = options[:date]
+        @period = 'custom' if @date
+      end
+
+      def request_url_base
+        "/api/v1/stats/timeseries?site_id=$SITE_ID"
+      end
+
+      def parse_response(body)
+        JSON.parse(body)['results']
+      end
+    end
+  end
+end

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = '0.0.3'
-end
+  VERSION = "0.1.5"
+end

data/plausible_api.gemspec

@@ -1,22 +1,27 @@
-# frozen_string_literal: true
+require_relative 'lib/plausible_api/version'
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+Gem::Specification.new do |spec|
+  spec.name          = "plausible_api"
+  spec.version       = PlausibleApi::VERSION
+  spec.authors       = ["Gustavo Garcia"]
+  spec.email         = ["gustavo@dailytics.com"]
 
-require 'plausible_api/version'
+  spec.summary       = 'A simple Plausible API wrapper for Rails'
+  spec.description   = 'A very humble wrapper for the new API by Plausible'
+  spec.homepage      = "https://github.com/dailytics/plausible_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-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://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']
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dailytics/plausible_api"
+  spec.metadata["changelog_uri"] = "https://github.com/dailytics/plausible_api"
 
-  s.add_dependency 'faraday', '~> 1.0'
-  s.required_ruby_version = '>= 2.4'
-end
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -1,48 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-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: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+date: 2021-02-23 00:00:00.000000000 Z
+dependencies: []
 description: A very humble wrapper for the new API by Plausible
-email: gustavo@dailytics.com
+email:
+- gustavo@dailytics.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/plausible_api.rb
-- lib/plausible_api/api/client.rb
-- lib/plausible_api/api/stats/aggregate.rb
-- lib/plausible_api/api/stats/realtime/visitors.rb
-- lib/plausible_api/api/stats/timeseries.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
 - plausible_api.gemspec
-homepage: https://github.com/dailytics/plausible-api
+homepage: https://github.com/dailytics/plausible_api
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/dailytics/plausible_api
+  source_code_uri: https://github.com/dailytics/plausible_api
+  changelog_uri: https://github.com/dailytics/plausible_api
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -51,7 +50,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/plausible_api/api/client.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'plausible_api/api/stats/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.to_s
-    end
-
-    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::Stats::Realtime::Visitors.new
-    end
-
-    private
-    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
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module PlausibleApi
-  module Stats
-    class Aggregate
-      def initialize(options = {})
-        @period  = options[:period] || '30d'
-        @metrics = options[:metrics] || 'visitors,pageviews,bounce_rate,visit_duration'
-        @filters  = options[:filters]
-        @date    = options[:date]
-      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
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module PlausibleApi
-  module Stats
-    class Timeseries
-      def initialize(options = {})
-        @period = options[:period] || '30d'
-        @filters = options[:filters]
-        @date   = options[:date]
-      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
-      end
-    end
-  end
-end