fathom_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b56f8631f9278d0a5e8631b168d07b807ef191896284e69711fac634da46efe
-  data.tar.gz: c66e9928e9c6ebff67d46fbe7479220bdbf13489a070c9e390a6f096294a3782
+  metadata.gz: 2f5fb64e963c720488054fef8bb3f7ed01bc0773546215f36a5d70189ac3272b
+  data.tar.gz: af494ca88974437fbd5b1e7c821ac41d75775b713d8f515b86148c46859adf4c
 SHA512:
-  metadata.gz: 3b0bb564ab470ae7e84af648dfd9d16ba792bee3366e54dd1ea4308d30b0457c6e46967fafcd3fe03af8ab5f04c7dd0a59936eec8f24bc853904e0b2b8511e20
-  data.tar.gz: be65304241b52804ed71a5830a75d06aa6be83a0d9015a1d4ccc04ad24de4977ff5058cee0db14b6b6b588a025f72d2499291f097aa923bed95b5d3e1438b3db
+  metadata.gz: ef334d4d5856b8cb7f5b069ff34474bf87a95d002541c99f3edfc91e486aef3b46d65f17ccf77037a3bace841233498a005f16809763c89168f64dabca48d145
+  data.tar.gz: 9d2d3ae828fdfdd91d3f33bcfe1f131ad8c63e96d5c687465376f5188dea485d9dc797b04b0c6fb7f3bc360cdef51bba2b8f2a7e30af3d7c37c4cc338a3445ad

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased]
+
+## [0.2.0] - 2022-05-26
+
+### Changed
+
+- Update the Aggregations endpoint to automatically call `.to_json` when using Filters if needed. Thanks @joemasilotti!
+- Bump version to 0.2.0
+
+## [0.1.2] - 2021-08-23
+
+### Added
+
+- Previous stable release of the ruby gem for the Fathom API.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fathom_api (0.1.0)
+    fathom_api (0.2.0)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 
@@ -9,26 +9,30 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    faraday (1.7.0)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    faraday_middleware (1.1.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     minitest (5.14.4)
     multipart-post (2.1.1)
@@ -62,6 +66,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -71,4 +76,4 @@ DEPENDENCIES
   standard
 
 BUNDLED WITH
-   2.2.3
+   2.2.33

data/README.md

@@ -1,5 +1,3 @@
-### Hello there! This gem is a placeholder and will be updated and working soon. Please do not install it yet.
-
 # Fathom API
 
 ### 🛠 An easy to use client with the Fathom API
@@ -49,21 +47,24 @@ response.email
 # => "you@starfleet.org"
 ```
 
-### A note on Fathom::List objects
+### Pagination
 
 When an API's response comes back with a object of "list", we automatically wrap that to attempt to provide some helper methods to ease your implementations.
 
 ```ruby
-list = client.sites.list
+list = client.sites.list(limit: 1)
 # => Fathom::List
 
-# get the cursor you can pass to the next request's starting_after param
-list.next_page
-# or get the ending_before param's cursor
-list.prev_page
+# We provide two helper methods to allow you to get the first or last id from the data response
+list.first_id
+list.last_id
 
 # check if the list has more after it with
 list.has_more?
+# => true
+
+# use the next page cursor in your next response
+list2 = client.sites.list(limit: 1, starting_after: list.last_id)
 ```
 
 ### Sites
@@ -112,9 +113,11 @@ client.current_visitors(site_id: site_id, {}) # Can add detailed: true for a mor
 ### Aggregation
 
 ```ruby
-client.aggregations.list(entity_id: entity_id, entity_type: entity_type, aggregates: aggregates, **params)
+client.aggregations.list(entity_id: entity_id, entity: entity, aggregates: aggregates, **params)
 ```
 
+You can find all the available parameters in the [official Fathom docs](https://usefathom.com/api#introduction)
+
 ## 🙏 Contributing
 
 This project uses Standard for formatting Ruby code. Please make sure to run standardrb before submitting pull requests. 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/afomera/fathom_api/blob/main/CODE_OF_CONDUCT.md).

data/lib/fathom/objects/list.rb

@@ -11,11 +11,11 @@ module Fathom
       @attributes["has_more"]
     end
 
-    def next_page
+    def last_id
       @attributes["data"].last.id
     end
 
-    def prev_page
+    def first_id
       @attributes["data"].first.id
     end
   end

data/lib/fathom/resources/aggregations.rb

@@ -1,9 +1,18 @@
 module Fathom
   class AggregationsResource < Resource
     # TODO: Ensure this works properly
-    def list(entity_id:, entity_type:, aggregates:, **params)
-      get_request("aggregations", params: params.merge(entity_id: entity_id,
-        entity_type: entity_type, aggregates: aggregates))
+    def list(entity_id:, entity:, aggregates:, **params)
+      filters = params.delete(:filters) || {}
+      filters = filters.to_json if filters.is_a?(Hash)
+
+      params.merge!(
+        entity_id: entity_id,
+        entity: entity,
+        aggregates: aggregates,
+        filters: filters
+      )
+
+      get_request("aggregations", params: params)
     end
   end
 end

data/lib/fathom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fathom
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fathom_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrea Fomera
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A gem for using the Fathom API