umami-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2bf01e43c4999e6c89a262b523fa26fc9c365e7c3b22c8e40e5ae4235859299
+  data.tar.gz: 3ba600eacacb24d3836d54ded7cdd5264a1af4f85da3f84a4a49dde022d87fe8
+SHA512:
+  metadata.gz: 44f9bd1f3362ee5d671f88ecd3ff2525303fbfde7c46360df90182b8ffc01c028dbe45679c3db9d87724e3a4993f6a96f37d3198938cdcc8f4c5415fde55c27b
+  data.tar.gz: 39211469acd7173916112aad2348222351b85ef4cfd00525483eedb0bbe145e49cdc48bcce4494db549037dfffc553d3efac48de9375461129e9c92b03296de9

data/.yardopts

@@ -0,0 +1,10 @@
+--no-private
+--protected
+--markup-provider=redcarpet
+--markup=markdown
+--output-dir docs
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-22
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Rameerez
+
+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,118 @@
+# Umami Ruby
+
+[![Gem Version](https://badge.fury.io/rb/umami-ruby.svg)](https://badge.fury.io/rb/umami-ruby)
+
+A Ruby wrapper for the Umami analytics API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umami-ruby'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install umami-ruby
+```
+
+## Documentation
+
+Full API documentation is available [online](https://rameerez.github.io/umami-ruby/) or can be generated using YARD:
+
+```bash
+yard doc
+yard server
+```
+
+## Usage
+
+### Configuration
+
+You can put this config in a handy location within your Rails project, like `config/initializers/umami.rb`
+
+#### For self-hosted Umami instances:
+
+```ruby
+# With username and password
+Umami.configure do |config|
+  config.uri_base = "https://your-umami-instance.com"
+  config.credentials = {
+    username: "your_username",
+    password: "your_password"
+  }
+end
+
+# Or with an access token
+Umami.configure do |config|
+  config.uri_base = "https://your-umami-instance.com"
+  config.access_token = "your_access_token"
+end
+```
+
+#### For Umami Cloud:
+
+```ruby
+Umami.configure do |config|
+  config.access_token = "your_api_key"
+  # No need to specify uri_base for Umami Cloud
+end
+```
+
+### Using the Client
+
+After configuration, you can use the client to interact with the Umami API:
+
+```ruby
+client = Umami::Client.new
+
+# Get all websites
+websites = client.websites
+
+# Get a specific website
+website = client.website("website_id")
+
+# Get website stats
+stats = client.website_stats("website_id", { startAt: 1656679719687, endAt: 1656766119687 })
+
+# Verify token
+token_info = client.verify_token
+```
+
+## Error Handling
+
+The gem defines several custom error classes:
+
+- `Umami::ConfigurationError`: Raised for configuration-related issues.
+- `Umami::AuthenticationError`: Raised for authentication-related issues.
+- `Umami::APIError`: Raised for API request failures.
+
+## Logging
+
+The gem uses a logger that can be configured:
+
+```ruby
+Umami.logger.level = Logger::DEBUG
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rameerez/umami-ruby. Our code of conduct is: just be nice and make your mom proud of what you do and post online.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/docs/Umami/APIError.html

@@ -0,0 +1,146 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: Umami::APIError
+  
+    &mdash; Documentation by YARD 0.9.36
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "Umami::APIError";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Umami.html" title="Umami (module)">Umami</a></span></span>
+     &raquo; 
+    <span class="title">APIError</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Exception: Umami::APIError
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="Error.html" title="Umami::Error (class)">Error</a></span></span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">StandardError</li>
+          
+            <li class="next"><span class='object_link'><a href="Error.html" title="Umami::Error (class)">Error</a></span></li>
+          
+            <li class="next">Umami::APIError</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/umami/errors.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Base error class for API-related errors</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="ClientError.html" title="Umami::ClientError (class)">ClientError</a></span>, <span class='object_link'><a href="NotFoundError.html" title="Umami::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="ServerError.html" title="Umami::ServerError (class)">ServerError</a></span></p>
+</div>
+
+
+
+
+
+
+
+
+  
+  
+  
+  
+  
+  
+  
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Jul 22 17:42:41 2024 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.36 (ruby-3.2.2).
+</div>
+
+    </div>
+  </body>
+</html>

data/docs/Umami/AuthenticationError.html

@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: Umami::AuthenticationError
+  
+    &mdash; Documentation by YARD 0.9.36
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "Umami::AuthenticationError";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Umami.html" title="Umami (module)">Umami</a></span></span>
+     &raquo; 
+    <span class="title">AuthenticationError</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Exception: Umami::AuthenticationError
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="Error.html" title="Umami::Error (class)">Error</a></span></span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">StandardError</li>
+          
+            <li class="next"><span class='object_link'><a href="Error.html" title="Umami::Error (class)">Error</a></span></li>
+          
+            <li class="next">Umami::AuthenticationError</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/umami/errors.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Error raised when authentication fails</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+  
+  
+  
+  
+  
+  
+  
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Jul 22 17:42:41 2024 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.36 (ruby-3.2.2).
+</div>
+
+    </div>
+  </body>
+</html>