fathom_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b56f8631f9278d0a5e8631b168d07b807ef191896284e69711fac634da46efe
-  data.tar.gz: c66e9928e9c6ebff67d46fbe7479220bdbf13489a070c9e390a6f096294a3782
+  metadata.gz: 2135fbb0e65011d59344ea4ade4ffc075b2b15611965011d5e5c2c8e08e7d111
+  data.tar.gz: 22eef7800e0b45c7f38514bdd11ea11e9f73fc3cdf2b8e683cf60fa4b54384e1
 SHA512:
-  metadata.gz: 3b0bb564ab470ae7e84af648dfd9d16ba792bee3366e54dd1ea4308d30b0457c6e46967fafcd3fe03af8ab5f04c7dd0a59936eec8f24bc853904e0b2b8511e20
-  data.tar.gz: be65304241b52804ed71a5830a75d06aa6be83a0d9015a1d4ccc04ad24de4977ff5058cee0db14b6b6b588a025f72d2499291f097aa923bed95b5d3e1438b3db
+  metadata.gz: 5ae5a4867c8039e5d636d98908d6e53238ec32c8ebc3d7729f59fde6fa83a7d4a7e2e2c860027ea8f56bad26f2ed848347ed65c1e757158831543d7f09c121ce
+  data.tar.gz: c3519d4925bc3764670d96297008615c5cd7cef8b1b3a80617290917a418dc39e03aa3c06a7e9abf9f495223ec9dbf23355e2057f52baa6b040051805171a909

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fathom_api (0.1.0)
+    fathom_api (0.1.1)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 

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

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fathom_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrea Fomera