fathom_analytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ef2617afd279bb381b921c7455379f8ea955c5203b70162680136e0d764778f
+  data.tar.gz: cf7f4a11afa39c034b3776a363adbc09aac76405c16fde3fdf7e54d6a9d8f6ca
+SHA512:
+  metadata.gz: c6f208079f8edc3f493fccd1ebbed879ee8f8d2b643b36a677475daea1c330d6c869f5ba25237341ad1534b921c62311c2477fcc4cf1b53a49f68495fe69f9d6
+  data.tar.gz: 9bbb5d5d912008aef6b401bfec5af3e2ec88924532b7e10e393055e0ab6a2201850bb03c51319034088aa86863f214b49ebc101376dc8ec0293af442a127c396

data/.env.example

@@ -0,0 +1,3 @@
+TEST_URL=https://example.com
+TEST_EMAIL=test@example.com
+TEST_PASSWORD=test

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI Specs
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Install dependencies
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run Tests
+      env:
+        RAILS_ENV: test
+      run: |
+        cp .env.example .env
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+
+# rspec failure tracking
+.rspec_status
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fa_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    fathom_analytics (0.1.0)
+      faraday (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.3)
+    dotenv (2.7.5)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.5)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    vcr (6.0.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1, >= 11.1.3)
+  dotenv (~> 2.7, >= 2.7.5)
+  fathom_analytics!
+  pry-byebug (~> 3.9)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vcr (~> 6.0)
+  webmock (~> 3.8, >= 3.8.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sunny Rana
+
+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

@@ -0,0 +1,100 @@
+![CI Specs](https://github.com/gpoisoned/fathom_analytics/workflows/CI%20Specs/badge.svg?branch=master)
+# Fathom Analytics Ruby Client
+
+A Ruby interface to [Fathom Analytics server](https://github.com/usefathom/fathom).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fathom_analytics'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fathom_analytics
+
+## Usage
+
+#### Creating an instance of the API client:
+
+``` ruby
+api = FathomAnalytics::Api.new(url: 'https://example.com', email: '', password: '')
+```
+
+#### Get all sites:
+``` ruby
+api.sites
+```
+
+#### Add a new site:
+``` ruby
+api.add_site(name: 'demo')
+```
+
+#### Remove a site:
+``` ruby
+api.remove_site(id: 1)
+```
+
+#### Get realtime site stats:
+``` ruby
+api.site_realtime_stats(id: 1)
+```
+
+#### Get site stats:
+``` ruby
+api.site_stats(id: 1, from: 1577862000, to: 1609484399)
+```
+
+#### Get aggregated site stats:
+``` ruby
+api.site_agg_stats(id: 1, from: 1577862000, to: 1609484399)
+```
+
+#### Get aggregated page stats:
+``` ruby
+api.page_agg_stats(id: 1, from: 1577862000, to: 1609484399)
+```
+
+#### Get aggregated page views:
+``` ruby
+api.page_agg_page_views_stats(id: 1, from: 1577862000, to: 1609484399)
+```
+
+#### Get aggregated referrer stats:
+``` ruby
+api.referrer_agg_stats(id: 1, from: 1577862000, to: 1609484399)
+```
+
+#### Get aggregated referrer page views:
+``` ruby
+api.referrer_agg_page_views_stats(id: 1, from: 1577862000, to: 1609484399)
+```
+
+#### Pagination
+
+Pagination is supported through `offset` and `limit` params.
+``` ruby
+api.site_stats(id: 1, from: 1577862000, to: 1609484399, offset: 1, limit: 10)
+```
+The default values for paginations params are as follows:
+1. `limit`  = 50
+2. `offset` = 0
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fathom_analytics"
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/fathom_analytics.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/fathom_analytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fathom_analytics"
+  spec.version       = FathomAnalytics::VERSION
+  spec.authors       = ["Sunny Rana"]
+  spec.email         = ["gpoisoned@gmail.com"]
+
+  spec.summary       = %q{Ruby client for Fathom Analytics server.}
+  spec.homepage      = "https://github.com/gpoisoned/fathom_analytics"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/gpoisoned/fathom_analytics"
+  spec.metadata["changelog_uri"] = "https://github.com/gpoisoned/fathom_analytics"
+
+  # 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"]
+
+  spec.add_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0' 
+  spec.add_development_dependency "byebug", '~> 11.1', '>= 11.1.3'
+  spec.add_development_dependency "pry-byebug", '~> 3.9'
+  spec.add_development_dependency "webmock", '~> 3.8', '>= 3.8.3'
+  spec.add_development_dependency "vcr", '~> 6.0'
+  spec.add_development_dependency "dotenv", '~> 2.7', '>= 2.7.5'
+end

data/lib/fathom_analytics.rb

@@ -0,0 +1,7 @@
+require 'json'
+require 'faraday'
+
+require "fathom_analytics/version"
+require "fathom_analytics/error"
+require "fathom_analytics/connection"
+require "fathom_analytics/api"

data/lib/fathom_analytics/api.rb

@@ -0,0 +1,161 @@
+module FathomAnalytics
+  class Api
+    LIMIT = 50
+
+    attr_reader :url, :email, :password
+
+    def initialize(url:, email:, password:)
+      @url = url
+      @email = email
+      @password = password
+      @auth_token = nil
+    end
+
+    def add_site(name:)
+      post_request(path: "/api/sites", params: { name: name })
+    end
+
+    def remove_site(id:)
+      delete_request(path: "/api/sites/#{id}")
+    end
+
+    def sites
+      get_request(path: "/api/sites")
+    end
+
+    def site_realtime_stats(id:)
+      get_request(path: "/api/sites/#{id}/stats/site/realtime")
+    end
+
+    def site_stats(id:, from:, to:, limit: LIMIT, offset: 0)
+      path = "/api/sites/#{id}/stats/site"
+      get_request(path: path, before: to, after: from, limit: limit, offset: offset)
+    end
+
+    def site_agg_stats(id:, from:, to:, limit: LIMIT, offset: 0)
+      path = "/api/sites/#{id}/stats/site/agg"
+      get_request(path: path, before: to, after: from, limit: limit, offset: offset)
+    end
+
+    def page_agg_stats(id:, from:, to:, limit: LIMIT, offset: 0)
+      path = "/api/sites/#{id}/stats/pages/agg"
+      get_request(path: path, before: to, after: from, limit: limit, offset: offset)
+    end
+
+    def page_agg_page_views_stats(id:, from:, to:, limit: LIMIT, offset: 0)
+      path = "/api/sites/#{id}/stats/pages/page_views"
+      get_request(path: path, before: to, after: from, limit: limit, offset: offset)
+    end
+
+    def referrer_agg_stats(id:, from:, to:, limit: LIMIT, offset: 0)
+      path = "/api/sites/#{id}/stats/referrers/agg"
+      get_request(path: path, before: to, after: from, limit: limit, offset: offset)
+    end
+
+    def referrer_agg_page_views_stats(id:, from:, to:, limit: LIMIT, offset: 0)
+      path = "/api/sites/#{id}/stats/referrers/page_views"
+      get_request(path: path, before: to, after: from, limit: limit, offset: offset)
+    end
+
+    def authenticate
+      params = {
+        "Email": email,
+        "Password": password
+      }
+      response = post_request(path: "/api/session", params: params, authenticated: false) do |raw_response|
+        set_auth_token(raw_response)
+      end
+      response
+    end
+
+    private
+
+    def get_request(path:, before: nil, after: nil, limit: nil, offset: nil, authenticated: true)
+      ensure_auth_token if authenticated
+
+      params = {}
+      params['before'] = before if before
+      params['after'] = after if after
+      params['limit'] = limit if limit
+      params['offset'] = offset if offset
+
+      response = connection.get(
+        path: path,
+        auth_token: @auth_token,
+        params: params
+      )
+
+      if response.status == 200
+        api_response(response.body)
+      else
+        raise FathomAnalytics::Error.new(response.status)
+      end
+    end
+
+    def post_request(path:, params:, authenticated: true, &block)
+      ensure_auth_token if authenticated
+
+      response = connection.post(
+        path: path,
+        params: params,
+        auth_token: @auth_token
+      )
+
+      if response.status == 200
+        yield response if block_given?
+
+        api_response(response.body)
+      else
+        raise FathomAnalytics::Error.new(response.status)
+      end
+    end
+
+    def delete_request(path:, authenticated: true)
+      ensure_auth_token if authenticated
+
+      response = connection.delete(
+        path: path,
+        auth_token: @auth_token
+      )
+
+      if response.status == 200
+        yield response if block_given?
+
+        api_response(response.body)
+      else
+        raise FathomAnalytics::Error.new(response.status)
+      end
+    end
+
+    def api_response(response_body)
+      parsed = JSON.parse(response_body)
+      parsed["Data"] || {}
+    rescue JSON::ParserError
+      {}
+    end
+
+    def ensure_auth_token
+      return unless @auth_token.nil?
+
+      authenticate
+    end
+
+    def set_auth_token(response)
+      set_cookie_header = response.headers['set-cookie']
+      @auth_token = parse_auth_header(set_cookie_header)
+
+      raise FathomAnalytics::Error.new("Failed to retrieve auth key") unless @auth_token
+    end
+
+    def parse_auth_header(header)
+      return nil if header.nil?
+
+      matches = header.match(/auth=([a-zA-Z0-9\-_]+);/)
+      matches[1] if matches
+    end
+
+    def connection
+      @connection ||= FathomAnalytics::Connection.new(base_url: url)
+    end
+  end
+end

data/lib/fathom_analytics/connection.rb

@@ -0,0 +1,39 @@
+module FathomAnalytics
+  class Connection
+    def initialize(base_url:)
+      @base_url = base_url
+      @_fd_connection = Faraday.new(
+        url: @base_url,
+        headers: {'Content-Type' => 'application/json'}
+      )
+    end
+
+    def get(path: '', params: {}, auth_token:)
+      get_url = @base_url + path
+      @_fd_connection.get(get_url) do |req|
+        params.each do |k, v|
+          req.params[k] = v
+        end
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Cookie'] = "auth=#{auth_token}" if auth_token
+      end
+    end
+
+    def post(path: '', params:, auth_token:)
+      post_url = @base_url + path
+      @_fd_connection.post(post_url) do |req|
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Cookie'] = "auth=#{auth_token}" if auth_token
+        req.body = params.to_json
+      end
+    end
+
+    def delete(path: '', auth_token:)
+      delete_url = @base_url + path
+      @_fd_connection.delete(delete_url) do |req|
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Cookie'] = "auth=#{auth_token}" if auth_token
+      end
+    end
+  end
+end

data/lib/fathom_analytics/error.rb

@@ -0,0 +1,7 @@
+module FathomAnalytics
+  class Error < StandardError
+    def initialize(message)
+      super message
+    end
+  end
+end

data/lib/fathom_analytics/version.rb

@@ -0,0 +1,3 @@
+module FathomAnalytics
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: fathom_analytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sunny Rana
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-01 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+description:
+email:
+- gpoisoned@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fathom_analytics.gemspec
+- lib/fathom_analytics.rb
+- lib/fathom_analytics/api.rb
+- lib/fathom_analytics/connection.rb
+- lib/fathom_analytics/error.rb
+- lib/fathom_analytics/version.rb
+homepage: https://github.com/gpoisoned/fathom_analytics
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gpoisoned/fathom_analytics
+  source_code_uri: https://github.com/gpoisoned/fathom_analytics
+  changelog_uri: https://github.com/gpoisoned/fathom_analytics
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Ruby client for Fathom Analytics server.
+test_files: []