calendlyr 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c61eeba097d722afae96ec580cd3c846b81ddf3086be6af4937ec4988a54a3d
-  data.tar.gz: e36f1d86bcfdded9881de1f5da03cf68bcaac08f83599be9398224f6484412be
+  metadata.gz: 8333c9dbe0f1d7e633eaff538790c0cd4f57ee3d9cf8c1b0f5e4638373578a60
+  data.tar.gz: 9eb3dfaab07649e6b15d1fca3286c6fab0592a74f689f6809c7b2506e13e6b2b
 SHA512:
-  metadata.gz: fc9d65be6a30c2319e386afed5301d9e6a45131fb846a5b3701b5d4f8d14afe292344bbf05e57bb3bdf78e68038eb962a2226fac75255d24269ee95da3cb2591
-  data.tar.gz: aab622e3c919bb2bbad49fb026e6f17bfd460f81b3929c3d4c854d2d230f1cd4712b1bb62711223b93477dbe347b6d87be9405698aaa1fbbce8313d193c1e1d7
+  metadata.gz: 81f0d93eb9049accadaf68e8af5174800bfb6630570008a69d50e3f0ede02c60d9577a59e9a2aa161d92c68222957cefae618fee7471b5474d2569317b8e86ab
+  data.tar.gz: 6073bce53858d69dc7c40b814e54bd3d3dce0be7abf720873f55441b2b1e62eae360ecf30b4f201703c12cd337b94b8ff7a1e78370e1848bc1844e262c2f393a

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.4.0]
+## [0.5.0]
 * First real usable release :tada:
 
-[0.4.0]: https://github.com/araluce/calendlyr/compare/v0.1.0...v0.4.0
+[0.5.0]: https://github.com/araluce/calendlyr/compare/v0.1.0...v0.5.0

data/README.md

@@ -7,10 +7,16 @@
 
 Easy and complete rubygem for [Calendly](https://calendly.com/). Currently supports [API v2](https://calendly.stoplight.io/docs/api-docs).
 
-No dependencies, just needed a Personal Access Token.
+Just needed a Personal Access Token.
 
 > If you need a Oauth authentication maybe you need [calendly-api-ruby-client](https://github.com/koshilife/calendly-api-ruby-client)
 
+## Dependencies
+
+No dependencies :tada:
+
+We know about the importance of not add dependencies that you don't want.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -144,12 +150,16 @@ client.organizations.retrieve_membership(membership_uuid: "membership_uuid")
 client.organizations.remove_user(membership_uuid: "membership_uuid")
 
 client.organization.events
+
+# List/Creaete webhooks
+client.organization.list_webhooks(scope: "scope")
+client.organization.create_webhook(url: "post_callback_url", events: ["invitee.canceled", "invitee.created"], scope: "scope")
 ````
 
 ### Webhooks
 ```ruby
 client.webhooks.list(organization_uri: "organization_uri", scope: "scope")
-client.webhooks.create(resource_uri: "resource_uri", events: ["invitee.canceled", "invitee.created"], organization_uri: "organization_uri", scope: "scope")
+client.webhooks.create(url: "post_callback_url", events: ["invitee.canceled", "invitee.created"], organization_uri: "organization_uri", scope: "scope")
 client.webhooks.retrieve(webhook_uuid: "webhook_uuid")
 client.webhooks.delete(webhook_uuid: "webhook_uuid")
 ```

data/lib/calendlyr/objects/organizations.rb

@@ -8,6 +8,14 @@ module Calendlyr
       client.organizations.list_invitations organization_uuid: uuid, **params
     end
 
+    def list_webhooks(**params)
+      client.webhooks.list(organization_uri: uri, **params)
+    end
+
+    def create_webhook(**params)
+      client.webhooks.create(organization_uri: uri, **params)
+    end
+
     def revoke_invitation(invitation_uuid:)
       client.organizations.revoke_invitation(organization_uuid: uuid, invitation_uuid: invitation_uuid)
     end

data/lib/calendlyr/resource.rb

@@ -7,6 +7,8 @@ module Calendlyr
   class Resource
     attr_reader :client
 
+    ERROR_CODES = %w[400 401 403 404 409 500]
+
     def initialize(client)
       @client = client
     end
@@ -21,14 +23,6 @@ module Calendlyr
       handle_response request(url, Net::HTTP::Post, body: body)
     end
 
-    def patch_request(url, body:)
-      handle_response request(url, Net::HTTP::Patch, body: body)
-    end
-
-    def put_request(url, body)
-      handle_response request(url, Net::HTTP::Put, body: body)
-    end
-
     def delete_request(url, params: {})
       handle_response request(url, Net::HTTP::Delete, params: params)
     end
@@ -54,22 +48,11 @@ module Calendlyr
     end
 
     def handle_response(response)
+      return true unless response.read_body
+
       body = JSON.parse(response.read_body)
-      case response.code
-      when 400
-        raise Error, "#{body["title"]}. #{body["message"]}"
-      when 401
-        raise Error, "#{body["title"]}. #{body["message"]}"
-      when 403
-        raise Error, "#{body["title"]}. #{body["message"]}"
-      when 404
-        raise Error, "#{body["title"]}. #{body["message"]}"
-      when 429
-        raise Error, "#{body["title"]}. #{body["message"]}"
-      when 500
-        raise Error, "#{body["title"]}. #{body["message"]}"
-      when 503
-        raise Error, "#{body["title"]}. #{body["message"]}"
+      if ERROR_CODES.include? response.code
+        raise Error, "[Error #{response.code}] #{body["title"]}. #{body["message"]}"
       else
         body
       end

data/lib/calendlyr/resources/organizations.rb

@@ -1,7 +1,7 @@
 module Calendlyr
   class OrganizationResource < Resource
     def invite(organization_uuid:, email:)
-      Invitation.new post_request("organizations/#{organization_uuid}/invitations", body: {email: email}).merge(client: client)
+      Invitation.new post_request("organizations/#{organization_uuid}/invitations", body: {email: email}).dig("resource").merge(client: client)
     end
 
     def list_invitations(organization_uuid:, **params)

data/lib/calendlyr/version.rb

@@ -1,3 +1,3 @@
 module Calendlyr
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/test/calendlyr/client_test.rb

@@ -2,7 +2,10 @@ require "test_helper"
 
 class ClientTest < Minitest::Test
   def test_token
-    client = Calendlyr::Client.new token: "test"
-    assert_equal "test", client.token
+    assert_equal "fake", client.token
+  end
+
+  def test_inspect
+    assert_equal "#<Calendlyr::Client>", client.inspect
   end
 end

data/test/calendlyr/resource_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ResourceTest < Minitest::Test
+  def test_handle_response_error
+    error_code = Calendlyr::Resource::ERROR_CODES.sample
+    stub(path: "users/me", response: {body: fixture_file("resources/#{error_code}"), status: error_code.to_i})
+
+    assert_raises Calendlyr::Error do
+      client.me
+    end
+  end
+end

data/test/calendlyr/resources/organizations_test.rb

@@ -40,25 +40,47 @@ class OrganizationsResourceTest < Minitest::Test
     assert_equal "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi", memberships.next_page_token
   end
 
+  def test_list_webhooks
+    stub(path: "webhook_subscriptions?organization=#{client.organization.uri}&scope=user", response: {body: fixture_file("webhooks/list"), status: 200})
+    webhooks = client.organization.list_webhooks(scope: "user")
+
+    assert_equal Calendlyr::Collection, webhooks.class
+    assert_equal Calendlyr::Webhook, webhooks.data.first.class
+    assert_equal 1, webhooks.count
+    assert_equal "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi", webhooks.next_page_token
+  end
+
+  def test_create_webhook
+    body = {url: "https://blah.foo/bar", events: ["invitee.created"], organization: client.organization.uri, scope: "user", user: client.me.uri}
+    stub(method: :post, path: "webhook_subscriptions", body: body, response: {body: fixture_file("webhooks/create"), status: 201})
+
+    assert client.webhooks.create(url: body[:url], events: body[:events], organization_uri: body[:organization], scope: body[:scope], user_uri: body[:user])
+  end
+
   def test_retrieve_invitation
-    organization_uuid = "AAAAAAAAAAAAAAAA"
     invitation_uuid = "AAAAAAAAAAAAAAAA"
-    response = {body: fixture_file("organizations/retrieve_invitation"), status: 200}
-    stub(path: "organizations/#{organization_uuid}/invitations/#{invitation_uuid}", response: response)
-    invitation = client.organizations.retrieve_invitation(organization_uuid: organization_uuid, invitation_uuid: invitation_uuid)
+
+    stub(path: "organizations/#{client.organization.uuid}/invitations/#{invitation_uuid}", response: {body: fixture_file("organizations/retrieve_invitation"), status: 200})
+    stub(method: :delete, path: "organizations/#{client.organization.uuid}/invitations/#{invitation_uuid}", response: {body: fixture_file("organizations/revoke_invitation")})
+    invitation = client.organizations.retrieve_invitation(organization_uuid: client.organization.uuid, invitation_uuid: invitation_uuid)
 
     assert_equal Calendlyr::Invitation, invitation.class
     assert_equal "test@example.com", invitation.email
+
+    assert invitation.associated_organization
+    assert invitation.revoke
   end
 
   def test_retrieve_membership
     membership_uuid = "AAAAAAAAAAAAAAAA"
     response = {body: fixture_file("organizations/retrieve_membership"), status: 200}
     stub(path: "organization_memberships/#{membership_uuid}", response: response)
+    stub(path: "users/#{membership_uuid}", response: {body: fixture_file("users/retrieve"), status: 200})
     membership = client.organizations.retrieve_membership(membership_uuid: membership_uuid)
 
     assert_equal Calendlyr::Membership, membership.class
     assert_equal "test@example.com", membership.user.email
+    assert_equal membership.associated_user, client.users.retrieve(user_uuid: membership_uuid)
   end
 
   def test_revoke_invitation
@@ -77,8 +99,6 @@ class OrganizationsResourceTest < Minitest::Test
   end
 
   def test_organization_invite_user
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
-
     email = "email@example.com"
     response = {body: fixture_file("organizations/invite"), status: 201}
     stub(method: :post, path: "organizations/#{client.organization.uuid}/invitations", body: {email: email}, response: response)
@@ -90,7 +110,6 @@ class OrganizationsResourceTest < Minitest::Test
   end
 
   def test_organization_list_invitations
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     stub(path: "organizations/#{client.organization.uuid}/invitations", response: {body: fixture_file("organizations/list_invitations"), status: 200})
     invitations = client.organization.list_invitations
 
@@ -101,13 +120,11 @@ class OrganizationsResourceTest < Minitest::Test
   end
 
   def test_organization_revoke_invitation
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     stub(method: :delete, path: "organizations/#{client.organization.uuid}/invitations/AAAAAAAAAAAAAAAA", response: {body: fixture_file("organizations/revoke_invitation")})
     assert client.organization.revoke_invitation(invitation_uuid: "AAAAAAAAAAAAAAAA")
   end
 
   def test_organization_invitation
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     response = {body: fixture_file("organizations/retrieve_invitation"), status: 200}
     stub(path: "organizations/#{client.organization.uuid}/invitations/AAAAAAAAAAAAAAAA", response: response)
     invitation = client.organization.invitation(invitation_uuid: "AAAAAAAAAAAAAAAA")
@@ -117,7 +134,6 @@ class OrganizationsResourceTest < Minitest::Test
   end
 
   def test_organization_events
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     stub(path: "scheduled_events?organization=#{client.organization.uri}", response: {body: fixture_file("events/list"), status: 200})
     events = client.organization.events
 
@@ -128,7 +144,6 @@ class OrganizationsResourceTest < Minitest::Test
   end
 
   def test_organization_memberships
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     stub(path: "organization_memberships?organization=#{client.organization.uri}", response: {body: fixture_file("organizations/list_memberships"), status: 200})
     memberships = client.organization.memberships
 

data/test/calendlyr/resources/scheduling_links_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class SchedulingLinksResourceTest < Minitest::Test
+  def test_create
+    owner_uri = "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2"
+    max_event_count = 20
+    owner_type = "EventType"
+    response = {body: fixture_file("scheduling_links/create"), status: 201}
+    stub(method: :post, path: "scheduling_links", body: {owner: owner_uri, max_event_count: max_event_count, owner_type: owner_type}, response: response)
+
+    assert client.scheduling_links.create(owner_uri: owner_uri, max_event_count: max_event_count, owner_type: owner_type)
+  end
+end

data/test/calendlyr/resources/users_test.rb

@@ -37,7 +37,6 @@ class UsersResourceTest < Minitest::Test
   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)
@@ -55,7 +54,6 @@ class UsersResourceTest < Minitest::Test
   end
 
   def test_event_types
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     me = client.me
 
     stub(path: "event_types?user=#{me.uri}&organization=#{me.organization.uri}", response: {body: fixture_file("event_types/list"), status: 200})
@@ -68,7 +66,6 @@ class UsersResourceTest < Minitest::Test
   end
 
   def test_events
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     me = client.me
 
     stub(path: "scheduled_events?user=#{me.uri}&organization=#{me.organization.uri}", response: {body: fixture_file("events/list"), status: 200})
@@ -81,7 +78,6 @@ class UsersResourceTest < Minitest::Test
   end
 
   def test_memberships
-    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
     me = client.me
 
     stub(path: "organization_memberships?user=#{me.uri}&organization=#{me.organization.uri}", response: {body: fixture_file("organizations/list_memberships"), status: 200})

data/test/calendlyr/resources/webhooks_test.rb

@@ -21,16 +21,19 @@ class WebhooksResourceTest < Minitest::Test
     stub(method: :post, path: "webhook_subscriptions", body: body, response: {body: fixture_file("webhooks/create"), status: 201})
 
     assert client.webhooks.create(url: body[:url], events: body[:events], organization_uri: body[:organization], scope: body[:scope], user_uri: body[:user])
+    assert client.organization.create_webhook(url: body[:url], events: body[:events], scope: body[:scope], user_uri: body[:user])
   end
 
   def test_retrieve
     webhook_uuid = "AAAAAAAAAAAAAAAA"
-    response = {body: fixture_file("webhooks/retrieve"), status: 200}
-    stub(path: "webhook_subscriptions/#{webhook_uuid}", response: response)
+    stub(path: "webhook_subscriptions/#{webhook_uuid}", response: {body: fixture_file("webhooks/retrieve"), status: 200})
+    stub(path: "users/AAAAAAAAAAAAAAAA", response: {body: fixture_file("users/retrieve"), status: 200})
     webhook = client.webhooks.retrieve(webhook_uuid: webhook_uuid)
 
     assert_equal Calendlyr::Webhook, webhook.class
     assert_equal "user", webhook.scope
+    assert_equal webhook.associated_user, client.users.retrieve(user_uuid: "AAAAAAAAAAAAAAAA")
+    assert_equal webhook.associated_organization, client.users.retrieve(user_uuid: "AAAAAAAAAAAAAAAA").organization
   end
 
   def test_delete

data/test/fixtures/organizations/invite.json

@@ -1,9 +1,11 @@
 {
-  "created_at": "2020-01-01T20:30:00Z",
-  "email": "email@example.com",
-  "last_sent_at": "2020-01-01T20:30:00Z",
-  "organization": "https://api.calendly.com/organizations/ABCDABCDABCDABCD",
-  "status": "pending",
-  "updated_at": "2020-01-01T20:30:00Z",
-  "uri": "https://api.calendly.com/organizations/ABCDABCDABCDABCD/invitations/DCBADCBADCBADCBA"
+  "resource": {
+    "created_at": "2020-01-01T20:30:00Z",
+    "email": "email@example.com",
+    "last_sent_at": "2020-01-01T20:30:00Z",
+    "organization": "https://api.calendly.com/organizations/ABCDABCDABCDABCD",
+    "status": "pending",
+    "updated_at": "2020-01-01T20:30:00Z",
+    "uri": "https://api.calendly.com/organizations/ABCDABCDABCDABCD/invitations/DCBADCBADCBADCBA"
+  }
 }

data/test/fixtures/organizations/list_invitations.json

@@ -1,7 +1,7 @@
 {
   "collection": [
     {
-      "uri": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations",
+      "uri": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/AAAAAAAAAAAAAAAA",
       "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
       "email": "test@example.com",
       "status": "accepted",

data/test/fixtures/organizations/retrieve_invitation.json

@@ -1,6 +1,6 @@
 {
   "resource": {
-    "uri": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations",
+    "uri": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/AAAAAAAAAAAAAAAA",
     "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
     "email": "test@example.com",
     "status": "accepted",

data/test/fixtures/resources/400.json

@@ -0,0 +1,10 @@
+{
+  "title": "Unauthenticated",
+  "message": "The access token is invalid",
+  "details": [
+    {
+      "parameter": "string",
+      "message": "string"
+    }
+  ]
+}

data/test/fixtures/resources/401.json

@@ -0,0 +1,10 @@
+{
+  "title": "Invalid Argument",
+  "message": "The supplied parameters are invalid.",
+  "details": [
+    {
+      "parameter": "string",
+      "message": "string"
+    }
+  ]
+}

data/test/fixtures/resources/403.json

@@ -0,0 +1,10 @@
+{
+  "title": "Permission Denied",
+  "message": "This user is not in your organization",
+  "details": [
+    {
+      "parameter": "string",
+      "message": "string"
+    }
+  ]
+}

data/test/fixtures/resources/404.json

@@ -0,0 +1,10 @@
+{
+  "title": "Resource Not Found",
+  "message": "The server could not find the requested resource.",
+  "details": [
+    {
+      "parameter": "string",
+      "message": "string"
+    }
+  ]
+}

data/test/fixtures/resources/409.json

@@ -0,0 +1,4 @@
+{
+  "title": "Already Exists",
+  "message": "Hook with this url already exists"
+}

data/test/fixtures/resources/500.json

@@ -0,0 +1,10 @@
+{
+  "title": "Internal Server Error",
+  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request.",
+  "details": [
+    {
+      "parameter": "string",
+      "message": "string"
+    }
+  ]
+}

data/test/test_helper.rb

@@ -11,6 +11,11 @@ require "minitest/autorun"
 require "webmock/minitest"
 
 class Minitest::Test
+  def initialize(name)
+    stub(path: "users/me", response: {body: fixture_file("users/retrieve"), status: 200})
+    super
+  end
+
   def client
     @client ||= Calendlyr::Client.new(token: "fake")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendlyr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - araluce
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -141,12 +141,13 @@ files:
 - lib/calendlyr/version.rb
 - test/calendlyr/client_test.rb
 - test/calendlyr/object_test.rb
-- test/calendlyr/resources/data_compliance.rb
+- test/calendlyr/resource_test.rb
+- test/calendlyr/resources/data_compliance_test.rb
 - test/calendlyr/resources/event_invitees_test.rb
 - test/calendlyr/resources/event_types_test.rb
 - test/calendlyr/resources/events_test.rb
 - test/calendlyr/resources/organizations_test.rb
-- test/calendlyr/resources/scheduling_links.rb
+- test/calendlyr/resources/scheduling_links_test.rb
 - test/calendlyr/resources/users_test.rb
 - test/calendlyr/resources/webhooks_test.rb
 - test/calendlyr_test.rb
@@ -164,6 +165,12 @@ files:
 - test/fixtures/organizations/retrieve_invitation.json
 - test/fixtures/organizations/retrieve_membership.json
 - test/fixtures/organizations/revoke_invitation.json
+- test/fixtures/resources/400.json
+- test/fixtures/resources/401.json
+- test/fixtures/resources/403.json
+- test/fixtures/resources/404.json
+- test/fixtures/resources/409.json
+- test/fixtures/resources/500.json
 - test/fixtures/scheduling_links/create.json
 - test/fixtures/users/reload.json
 - test/fixtures/users/retrieve.json
@@ -199,12 +206,13 @@ summary: Ruby bindings for Calendly API.
 test_files:
 - test/calendlyr/client_test.rb
 - test/calendlyr/object_test.rb
-- test/calendlyr/resources/data_compliance.rb
+- test/calendlyr/resource_test.rb
+- test/calendlyr/resources/data_compliance_test.rb
 - test/calendlyr/resources/event_invitees_test.rb
 - test/calendlyr/resources/event_types_test.rb
 - test/calendlyr/resources/events_test.rb
 - test/calendlyr/resources/organizations_test.rb
-- test/calendlyr/resources/scheduling_links.rb
+- test/calendlyr/resources/scheduling_links_test.rb
 - test/calendlyr/resources/users_test.rb
 - test/calendlyr/resources/webhooks_test.rb
 - test/calendlyr_test.rb
@@ -222,6 +230,12 @@ test_files:
 - test/fixtures/organizations/retrieve_invitation.json
 - test/fixtures/organizations/retrieve_membership.json
 - test/fixtures/organizations/revoke_invitation.json
+- test/fixtures/resources/400.json
+- test/fixtures/resources/401.json
+- test/fixtures/resources/403.json
+- test/fixtures/resources/404.json
+- test/fixtures/resources/409.json
+- test/fixtures/resources/500.json
 - test/fixtures/scheduling_links/create.json
 - test/fixtures/users/reload.json
 - test/fixtures/users/retrieve.json

data/test/calendlyr/resources/scheduling_links.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class SchedulingLinksResourceTest < Minitest::Test
-  def test_create
-    body = {owner_uri: "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2", max_event_count: 20, owner_type: "EventType"}
-    stub(method: :post, path: "scheduling_links", body: body, response: {body: fixture_file("scheduling_links/create"), status: 201})
-
-    assert client.data_compliance.delete_invitee_data(**body)
-  end
-end