plausible_api 0.0.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be1224dad0283128a3e21c2d4e53061845ddc2424e2a89655eb4a129925cb4d
-  data.tar.gz: b665e6e0dea74c2fe9e1f1309a418cbfe2a5f9be55a4ac0f14845ba6a207fc70
+  metadata.gz: 61ec37015a39b48b8ef1a5ff88f98452a87c590232ee527f03591d9fe3928a8d
+  data.tar.gz: d8a7df06ccea331230058b18a900b41c850a55ca18d9e850d1cc2fbf7fa7bbcc
 SHA512:
-  metadata.gz: 645bd976b0dc10c743232daa6752bee9bb5d9e29ee96235ac0d6efa541ffa1d3fe8e3518e510701de377dd3621e44a4c9b0c54cb99a7b50ffe8b85879036ce8c
-  data.tar.gz: 312e92ef37577f2e58e7ffabf72320bc8c9fc431c651779f0ccd2d264d0aa144e08a10ac8a4c71375ceaed5a17d0814b7d36e8d4446cbcc41278d7b775f3d43b
+  metadata.gz: a0ce1d1dc380b44136fc38f193e307ee7b84872e6835043c02ebe89497c702daaf404efafe855c9b11f867569c612fe260ac0f1c79c959b30359d39df192d08c
+  data.tar.gz: 0b28a11d857c1b2a9b83f5336fc833abb722e9492d602172f829c0bb12956c9aba7c426649ed01428a65f88d4c49ea421d44b09a808c639aa43c83b8453f8ada

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.3)
+
+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,10 @@ 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)
-c.aggregate({ period: '3d' })
-c.aggregate({ period: '3d', metrics: 'visitors,pageviews' })
-c.aggregate({ period: '3d', metrics: 'visitors,pageviews', filter: 'event:page==/order/confirmation' })
+# 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' })
 
 # You'll get something like this:
 => {"bounce_rate"=>{"value"=>81.0}, "pageviews"=>{"value"=>29}, "visit_duration"=>{"value"=>247.0}, "visitors"=>{"value"=>14}}
@@ -35,30 +39,39 @@ You have all these options to get the timeseries
 # 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' })
+# Set parameters (period, filters, interval)
+c.timeseries({ period: '7d' })
+c.timeseries({ period: '7d', filters: 'event:page==/order/confirmation' })
 
 # You'll get something like this:
-=> [{"date"=>"2021-01-11", "value"=>100}, {"date"=>"2021-01-12", "value"=>120}, {"date"=>"2021-01-13", "value"=>80}]
+=> [{"date"=>"2021-01-11", "value"=>100}, {"date"=>"2021-01-12", "value"=>120}, {"date"=>"2021-01-13", "value"=>80}...]
 ```
 
-### Realtime >> Visitors
+### 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'
-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
-- Tests
+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,52 @@
+# frozen_string_literal: true
+
+require 'plausible_api/stats/realtime/visitors'
+require 'plausible_api/stats/aggregate'
+require 'plausible_api/stats/timeseries'
+
+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 realtime_visitors
+      call PlausibleApi::Stats::Realtime::Visitors.new
+    end
+
+    def valid?
+      realtime_visitors.is_a? Integer
+    end
+
+    private
+    def call(api)      
+      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  
+
+      JSON.parse http.request(req).body
+    end
+  end
+end

data/lib/plausible_api/stats/aggregate.rb

@@ -0,0 +1,23 @@
+# 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]
+        @compare = options[:compare]
+      end
+
+      def request_url
+        url = "/api/v1/stats/aggregate?site_id=$SITE_ID"
+        url += "&period=#{@period}" if @period
+        url += "&metrics=#{@metrics}" if @metrics
+        url += "&filters=#{CGI.escape(@filters)}" if @filters
+        url += "&compare=#{@compare}" if @compare
+        url
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PlausibleApi 
+  module Stats
+    module Realtime
+      class Visitors
+        def initialize
+        end
+
+        def request_url
+          "/api/v1/stats/realtime/visitors?site_id=$SITE_ID"
+        end
+      end
+    end
+  end
+end

data/lib/plausible_api/stats/timeseries.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PlausibleApi
+  module Stats
+    class Timeseries
+      def initialize(options = {})
+        @period   = options[:period] || '30d'
+        @filters  = options[:filters]
+        @interval = options[:interval]
+      end
+
+      def request_url
+        url = "/api/v1/stats/timeseries?site_id=$SITE_ID"
+        url += "&period=#{@period}" if @period
+        url += "&filters=#{CGI.escape(@filters)}" if @filters
+        url += "&interval=#{@interval}" if @interval
+        url
+      end
+    end
+  end
+end

data/lib/plausible_api/version.rb

@@ -1,3 +1,3 @@
 module PlausibleApi
-  VERSION = '0.0.2'
-end
+  VERSION = "0.1.3"
+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,45 @@
 --- !ruby/object:Gem::Specification
 name: plausible_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.3
 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-15 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/realtime/visitors.rb
-- lib/plausible_api/api/stats/aggregate.rb
-- lib/plausible_api/api/stats/timeseries.rb
+- lib/plausible_api/client.rb
+- lib/plausible_api/stats/aggregate.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 +48,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/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::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/realtime/visitors.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-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,25 +0,0 @@
-# frozen_string_literal: true
-
-module PlausibleApi
-  module Stats
-    class Aggregate
-      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
-        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
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-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