calendlyr 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716fb90f54ab5c73f5441ccb7d8d6f8e636bceb3b3f55a6a9053fc06adabb2b0
-  data.tar.gz: 6bebccb4df4028bfdbad116fdef8b49768e640f4858dbb1fc7a930d98cf558f0
+  metadata.gz: e53e19c9a9bcc92787f9fe776a53e64668eb13939ff7cddb8ebc42220a2346f2
+  data.tar.gz: 3a36e15c5c436c852edbf69d177e147b3bf7615a0a5bec93e7a257947df39f5a
 SHA512:
-  metadata.gz: 79f76039110d8ff409c573229851e4cc130772f210a769d41bb2dac8ac05679b5a9db07a1d543604dc0e2858cc8c604dac16459fcdbbbeac9e059ce91f0b7267
-  data.tar.gz: 5de26c0f7b9da6389918ba123935902814ce125dbd193ed50596d06c329044bb161cacb7d9ce5d0b11a032157a01f3e06d6551b2b27d0e542b964f0a5dae11c2
+  metadata.gz: c86a6982263871804c661e3f2b554d3d49d253835f4faebac93c6acdcc4538078ba7dd77d837e8e5f8533cf9ae22da05b813c445ea8e90e903e1269a6e138cc5
+  data.tar.gz: af2ab8a21873283cdd588267a7c39ba2699e949bb829c15a6a66f61672ad496e69b776ed93849a667cf34e73ab62b1b7eaa7e005165710eca87e9bb5721348b4

data/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ["2.4", "2.5", "2.6", "2.7", "3.0"]
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
 
     steps:
       - uses: actions/checkout@master

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.3.6]
+* User caching
+
 ## [0.3.4]
 * Renaming variables and directories Calendly to Calendlyr
 
@@ -28,6 +31,7 @@ All notable changes to this project will be documented in this file.
 ## 0.1.0
 * Birthday!
 
+[0.3.6]: https://github.com/araluce/calendlyr/compare/v0.3.4...v0.3.6
 [0.3.4]: https://github.com/araluce/calendlyr/compare/v0.3.3...v0.3.4
 [0.3.3]: https://github.com/araluce/calendlyr/compare/v0.3.2...v0.3.3
 [0.3.2]: https://github.com/araluce/calendlyr/compare/v0.3.0...v0.3.2

data/README.md

@@ -1,5 +1,5 @@
 [![](https://img.shields.io/github/license/araluce/calendlyr)](https://github.com/araluce/calendlyr/blob/master/LICENSE.txt)
-![](https://github.com/araluce/calendlyr/actions/workflows/ci.yml/badge.svg)
+[![](https://github.com/araluce/calendlyr/actions/workflows/ci.yml/badge.svg)](https://github.com/araluce/calendlyr/actions)
 [![codecov](https://codecov.io/gh/araluce/calendlyr/branch/master/graph/badge.svg?token=YSUU4PHM6Y)](https://codecov.io/gh/araluce/calendlyr)
 [![Gem Version](https://badge.fury.io/rb/calendlyr.svg)](https://badge.fury.io/rb/calendlyr)
 
@@ -84,6 +84,17 @@ client.me.memberships
 #=> Calendlyr::Collection @data=[#<Calendlyr::MemberShip>, #<Calendlyr::MemberShip>]
 ```
 
+#### Me (Cached)
+
+Probably you need to make many calls through `client.me`, so we decided to not make calls for every `client.me` reference by caching it the first time. However, if you need to reload the content of `me` you can `force_relaod` to force a new call.
+
+```ruby
+client.me # makes a call and caches the response
+client.me # no call, value cached
+client.me(force_reload: true) # makes a new call and update cache value
+```
+
+
 ### Event Types
 ````ruby
 client.event_types.list user_uri: "user_uri", organization_uri: "organization_uri"
@@ -118,7 +129,7 @@ client.organization.list_invitations
 # Get invitation
 client.organizations.retrieve_invitation(organization_uuid: "organization_uuid", invitation_uuid: "invitation_uuid")
 client.organization.invitation(invitation_uuid: "invitation_uuid")
-#Revoke invitation
+# Revoke invitation
 client.organizations.revoke_invitation(organization_uuid: "organization_uuid", invitation_uuid: "organization_uuid")
 client.organization.revoke_invitation(invitation_uuid: "organization_uuid")
 invitation = client.organization.invitation(invitation_uuid: "invitation_uuid")
@@ -160,4 +171,6 @@ When adding resources, add to the list of resources in lib/calendlyr. Additional
 
 ## Thanks
 
+Many thanks [@markets](https://github.com/markets) for all comments, details and tips for this rubygem project and for made me grow professionally in my day by day :raised_hands:
+
 Thanks [@excid3](https://github.com/excid3) and his [Vultr.rb](https://github.com/excid3/vultr.rb) rubygem project.

data/lib/calendlyr/client.rb

@@ -8,8 +8,9 @@ module Calendlyr
       @token = token
     end
 
-    def me
-      users.me
+    def me(force_reload: false)
+      @me = nil if force_reload
+      @me ||= users.me
     end
 
     def organization

data/lib/calendlyr/version.rb

@@ -1,3 +1,3 @@
 module Calendlyr
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/test/calendlyr/resources/users_test.rb

@@ -28,6 +28,22 @@ class UsersResourceTest < Minitest::Test
     assert_equal "test@example.com", me.email
   end
 
+  def test_me_caching
+    response = {body: fixture_file("users/retrieve"), status: 200}
+    stub = stub(path: "users/me", response: response)
+    me = client.me
+    remove_request_stub(stub)
+    assert_equal client.me, me
+  end
+
+  def test_me_caching_reload
+    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
+    me = client.me
+    stub(path: "users/me", response: {body: fixture_file("users/reload"), status: 200})
+    reloaded_me = client.me(force_reload: true)
+    assert me.name != reloaded_me.name
+  end
+
   def test_organization
     response = {body: fixture_file("users/retrieve"), status: 200}
     stub(path: "users/me", response: response)

data/test/fixtures/users/reload.json

@@ -0,0 +1,14 @@
+{
+  "resource": {
+    "uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
+    "name": "John Doe Reloaded",
+    "slug": "acmesales",
+    "email": "test@example.com",
+    "scheduling_url": "https://calendly.com/acmesales",
+    "timezone": "America/New York",
+    "avatar_url": "https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png",
+    "created_at": "2019-01-02T03:04:05.678Z",
+    "updated_at": "2019-08-07T06:05:04.321Z",
+    "current_organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA"
+  }
+}

data/test/test_helper.rb

@@ -12,7 +12,7 @@ require "webmock/minitest"
 
 class Minitest::Test
   def client
-    Calendlyr::Client.new(token: "fake")
+    @client ||= Calendlyr::Client.new(token: "fake")
   end
 
   def fixture_file(fixture)
@@ -23,5 +23,6 @@ class Minitest::Test
     stub_req = stub_request(method, "#{Calendlyr::Client::BASE_URL}/#{path}")
     stub_req.with(body: body) if [:post, :put, :patch].include?(method)
     stub_req.to_return(**response)
+    stub_req
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendlyr
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - araluce
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,6 +165,7 @@ files:
 - test/fixtures/organizations/retrieve_membership.json
 - test/fixtures/organizations/revoke_invitation.json
 - test/fixtures/scheduling_links/create.json
+- test/fixtures/users/reload.json
 - test/fixtures/users/retrieve.json
 - test/fixtures/webhooks/create.json
 - test/fixtures/webhooks/delete.json
@@ -222,6 +223,7 @@ test_files:
 - test/fixtures/organizations/retrieve_membership.json
 - test/fixtures/organizations/revoke_invitation.json
 - test/fixtures/scheduling_links/create.json
+- test/fixtures/users/reload.json
 - test/fixtures/users/retrieve.json
 - test/fixtures/webhooks/create.json
 - test/fixtures/webhooks/delete.json