calendlyr 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1154b32aa1af6668b71d74fb9af0e8bd695b53c21fc49d6ed45fbee180bd5a74
+  data.tar.gz: bb85f5220261459ebf3fd4304fa207be57ac6b5a8226202d9ac2816064b3229e
+SHA512:
+  metadata.gz: a4f4ccb083646d19c45599294ba2684b302960cbff32d6eac1ab8c6f02f1ce76f570b96057638b11623e4d4dcde3baa8e11dbfb905ce2fb93d3c71ac0fa353c8
+  data.tar.gz: 86566019597243e8e84a1a48f1540e8e8cbbc14b8641ba9a816c62ce8267e446ab7ddb596ddeb1a94464d2536059f0ee975a2d1c4b39b9eb6a269b17ded2182e

data/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - master
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.4", "2.5", "2.6", "2.7", "3.0"]
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: StandardRb check
+        run: bundle exec standardrb
+
+      - name: Run tests
+        run: |
+          bundle exec rake test
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor
+.idea/
+bin/my_console

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.3.3]
+* Fix - Error when trying to send an invitation through the organization
+* More testing = More coverage
+
+## [0.3.2]
+* Minor fixes
+
+## [0.3.0]
+* No runtime dependencies
+* Minor fixes
+
+## [0.2.0]
+* Support for ruby 3.0
+* Minor fixes
+
+## [0.1.1]
+* Changed required ruby version from `>= 2.3.0` to `>= 2.4.0`
+* Minitest
+* Minor fixes
+
+## 0.1.0
+* Birthday!
+
+[0.3.3]: https://github.com/araluce/calendly.rb/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/araluce/calendly.rb/compare/v0.3.0...v0.3.2
+[0.3.0]: https://github.com/araluce/calendly.rb/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/araluce/calendly.rb/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/araluce/calendly.rb/compare/v0.1.0...v0.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in calendly.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "standard"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 araluce
+
+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,159 @@
+[![](https://img.shields.io/github/license/araluce/calendly.rb)](https://github.com/araluce/calendly.rb/blob/master/LICENSE.txt)
+![](https://github.com/araluce/calendly.rb/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/araluce/calendly.rb/branch/master/graph/badge.svg?token=YSUU4PHM6Y)](https://codecov.io/gh/araluce/calendly.rb)
+[![GitHub version](https://badge.fury.io/gh/araluce%2Fcalendly.rb.svg)](https://badge.fury.io/gh/araluce%2Fcalendly.rb)
+
+# Calendly API Rubygem
+
+Easy and complete rubygem for [Calendly](https://calendly.com/). Currently supports [API v2](https://calendly.stoplight.io/docs/api-docs).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'calendlyr', github: "araluce/calendly.rb"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install calendlyr
+
+## Usage
+
+To access the API, you'll need to create a `Calendly::Client` and pass in your API key. You can generate your Personal Access Token at [https://calendly.com/integrations/api_webhooks](https://calendly.com/integrations/api_webhooks)
+
+```ruby
+client = Calendly::Client.new(api_key: ENV["CALENDLY_API_KEY"])
+```
+
+The client then gives you access to each of the resources.
+
+## Resources
+
+The gem maps as closely as we can to the Calendly API so you can easily convert API examples to gem code.
+
+Responses are created as objects like `Calendly::Event`. Having types like `Calendly::User` is handy for understanding what type of object you're working with. They're built using OpenStruct so you can easily access data in a Ruby-ish way.
+
+##### Pagination
+
+`collection` endpoints return pages of results. The result object will have a `data` key to access the results, as well as pagination like `next_page` for retrieving the next pages. You may also specify the
+
+```ruby
+results = client.me.events(count: 5)
+#=> Calendly::Collection
+
+results.count
+#=> 5
+
+results.data
+#=> [#<Calendly::Event>, #<Calendly::Event>]
+
+results.next_page_token
+#=> "KfKBetd7bS0wsFINjYky9mp8ZJXv76aL"
+
+# Retrieve the next page
+client.me.events(count: 5, next_page_token: results.next_page_token)
+#=> Calendly::Collection
+```
+
+### Users
+```ruby
+client.me
+client.users.me
+client.retrieve(user_uuid: "uuid")
+
+client.organization
+#=> #<Calendly::Organization>
+
+client.me.event_types
+#=> Calendly::Collection @data=[#<Calendly::EventType>, #<Calendly::EventType>]
+
+client.me.events
+#=> Calendly::Collection @data=[#<Calendly::Event>, #<Calendly::Event>]
+
+client.me.memberships
+#=> Calendly::Collection @data=[#<Calendly::MemberShip>, #<Calendly::MemberShip>]
+```
+
+### Event Types
+````ruby
+client.event_types.list user_uri: "user_uri", organization_uri: "organization_uri"
+client.event_types.retrieve event_type_uuid: "id"
+````
+
+### Events
+````ruby
+client.events.list user_uri: "user_uri", organization_uri: "organization_uri"
+client.events.retrieve event_uuid: "event_uuid"
+````
+
+### Event Invitees
+````ruby
+client.event_invitees.list event_uuid: "event_uuid"
+client.event_invitees.retrieve event_uuid: "event_uuid", invitee_uuid: "invitee_uuid"
+````
+
+### Scheduling Links
+````ruby
+client.scheduling_links.create owner_uri: "owner_uri", max_event_count: 1, owner_type: "EventType"
+````
+
+### Organizations
+````ruby
+# Create invitation
+client.organizations.invite(organization_uuid: "organization_uuid", email: "test@test.com")
+client.organization.invite(email: "test@test.com")
+# List invitations
+client.organizations.list_invitations(organization_uuid: "organization_uuid")
+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
+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")
+invitation.revoke
+
+# List memberships
+client.organizations.list_memberships
+client.organization.memberships
+# Get membership
+client.organizations.retrieve_membership(membership_uuid: "membership_uuid")
+# Remove membership
+client.organizations.remove_user(membership_uuid: "membership_uuid")
+
+client.organization.events
+````
+
+### 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.retrieve(webhook_uuid: "webhook_uuid")
+client.webhooks.delete(webhook_uuid: "webhook_uuid")
+```
+
+### Data Compliance
+```ruby
+client.data_compliance.delete_invitee_data
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/araluce/calendly.rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+When adding resources, add to the list of resources in lib/calendly.rb. Additionally, write a spec and add it to the list in the README.
+
+## Thanks
+
+Thanks [@excid3](https://github.com/excid3) and his [Vultr.rb](https://github.com/excid3/vultr.rb) rubygem project.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "calendly"
+
+client = Calendly::Client.new(api_key: ENV["CALENDLY_API_KEY"])
+
+puts
+puts "We've created a 'client' variable as a Calendly::Client using ENV['CALENDLY_API_KEY'] as the API key."
+puts
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rake test

data/calendly.gemspec

@@ -0,0 +1,27 @@
+require "./lib/calendly/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "calendlyr"
+  spec.version = Calendly::VERSION
+  spec.authors = ["araluce"]
+  spec.email = ["araluce11@gmail.com"]
+
+  spec.summary = "Ruby bindings for Calendly API."
+  spec.description = "Ruby bindings for Calendly API. Calendly APIs can be found here: https://calendly.stoplight.io/docs/api-docs/"
+  spec.homepage = "https://github.com/araluce/calendly.rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "webmock", "~> 3.14.0"
+  spec.add_development_dependency "codecov"
+  spec.add_development_dependency "simplecov"
+end

data/lib/calendly/client.rb

@@ -0,0 +1,57 @@
+module Calendly
+  class Client
+    BASE_URL = "https://api.calendly.com"
+
+    attr_reader :api_key
+
+    def initialize(api_key:)
+      @api_key = api_key
+      raise Error, "Add an api_key to use Calendly. Calendly::Client.new(api_key: 'your_api_key')" unless api_key
+    end
+
+    def me
+      users.me
+    end
+
+    def organization
+      me.organization
+    end
+
+    def users
+      UserResource.new(self)
+    end
+
+    def organizations
+      OrganizationResource.new(self)
+    end
+
+    def event_types
+      EventTypeResource.new(self)
+    end
+
+    def events
+      EventResource.new(self)
+    end
+
+    def event_invitees
+      EventInviteeResource.new(self)
+    end
+
+    def scheduling_links
+      SchedulingLinkResource.new(self)
+    end
+
+    def webhooks
+      WebhookResource.new(self)
+    end
+
+    def data_compliance
+      DataComplianceResource.new(self)
+    end
+
+    # Avoid returning #<Calendly::Client @api_key="api_key" ...>
+    def inspect
+      "#<Calendly::Client>"
+    end
+  end
+end

data/lib/calendly/collection.rb

@@ -0,0 +1,31 @@
+module Calendly
+  class Collection
+    attr_reader :data, :count, :next_page, :next_page_token, :client
+
+    def self.from_response(response, key:, type:, client:)
+      new(
+        data: response[key].map { |attrs| type.new(attrs.merge(client: client)) },
+        count: response.dig("pagination", "count"),
+        next_page: response.dig("pagination", "next_page"),
+        client: client
+      )
+    end
+
+    def initialize(data:, count:, next_page:, client:)
+      @data = data
+      @count = count
+      @next_page = next_page
+      @next_page_token = get_params(next_page)["page_token"]&.first
+      @client = client
+    end
+
+    private
+
+    def get_params(url)
+      return {} unless url
+
+      uri = URI.parse(url)
+      CGI.parse(uri.query)
+    end
+  end
+end

data/lib/calendly/error.rb

@@ -0,0 +1,4 @@
+module Calendly
+  class Error < StandardError
+  end
+end

data/lib/calendly/object.rb

@@ -0,0 +1,27 @@
+require "ostruct"
+
+module Calendly
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes.merge(uuid: extract_uuid(attributes)))
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+
+    def extract_uuid(attrs)
+      attrs["uri"] ? get_slug(attrs["uri"]) : nil
+    end
+
+    def get_slug(path)
+      path.split("/").last
+    end
+  end
+end

data/lib/calendly/objects/event_invitees.rb

@@ -0,0 +1,4 @@
+module Calendly
+  class EventInvitee < Object
+  end
+end

data/lib/calendly/objects/event_types.rb

@@ -0,0 +1,4 @@
+module Calendly
+  class EventType < Object
+  end
+end

data/lib/calendly/objects/events.rb

@@ -0,0 +1,4 @@
+module Calendly
+  class Event < Object
+  end
+end

data/lib/calendly/objects/invitations.rb

@@ -0,0 +1,11 @@
+module Calendly
+  class Invitation < Object
+    def associated_organization
+      @associated_organization ||= Organization.new({"uri" => organization}.merge(client: client))
+    end
+
+    def revoke
+      associated_organization.revoke_invitation invitation_uuid: uuid
+    end
+  end
+end

data/lib/calendly/objects/memberships.rb

@@ -0,0 +1,7 @@
+module Calendly
+  class Membership < Object
+    def associated_user
+      client.users.retrieve user_uuid: get_slug(user.uri)
+    end
+  end
+end

data/lib/calendly/objects/organizations.rb

@@ -0,0 +1,27 @@
+module Calendly
+  class Organization < Object
+    def invite_user(email:)
+      client.organizations.invite organization_uuid: uuid, email: email
+    end
+
+    def list_invitations(**params)
+      client.organizations.list_invitations organization_uuid: uuid, **params
+    end
+
+    def revoke_invitation(invitation_uuid:)
+      client.organizations.revoke_invitation(organization_uuid: uuid, invitation_uuid: invitation_uuid)
+    end
+
+    def invitation(invitation_uuid:)
+      client.organizations.retrieve_invitation(organization_uuid: uuid, invitation_uuid: invitation_uuid)
+    end
+
+    def events(user_uri: nil, **params)
+      client.events.list user_uri: user_uri, organization_uri: uri, **params
+    end
+
+    def memberships(user_uri: nil, **params)
+      client.organizations.list_memberships user_uri: user_uri, organization_uri: uri, **params
+    end
+  end
+end

data/lib/calendly/objects/scheduling_links.rb

@@ -0,0 +1,4 @@
+module Calendly
+  class SchedulingLink < Object
+  end
+end

data/lib/calendly/objects/users.rb

@@ -0,0 +1,19 @@
+module Calendly
+  class User < Object
+    def organization
+      @organization ||= Organization.new({"uri" => current_organization}.merge(client: client))
+    end
+
+    def event_types(**params)
+      client.event_types.list user_uri: uri, organization_uri: current_organization, **params
+    end
+
+    def events(**params)
+      client.events.list user_uri: uri, organization_uri: current_organization, **params
+    end
+
+    def memberships(organization_uri: nil, **params)
+      client.organizations.list_memberships user_uri: uri, organization_uri: organization_uri, **params
+    end
+  end
+end

data/lib/calendly/objects/webhooks.rb

@@ -0,0 +1,11 @@
+module Calendly
+  class Webhook < Object
+    def associated_user
+      client.users.retrieve(user_uuid: get_slug(user))
+    end
+
+    def associated_organization
+      @associated_organization ||= Organization.new({"uri" => organization}.merge(client: client))
+    end
+  end
+end

data/lib/calendly/resource.rb

@@ -0,0 +1,73 @@
+module Calendly
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {})
+      handle_response request(url, Net::HTTP::Get, params: params)
+    end
+
+    def post_request(url, body:)
+      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
+
+    def request(url, req_type, body: {}, params: {}, base_url: Client::BASE_URL)
+      uri = URI("#{base_url}/#{url}")
+
+      if params.any?
+        params = URI.decode_www_form(uri.query || "") + params.to_a
+        uri.query = URI.encode_www_form params
+      end
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = req_type.new(uri)
+      request["Content-Type"] = "application/json"
+      request["Authorization"] = "Bearer #{client.api_key}"
+      request.body = body.to_json if body.any?
+
+      http.request(request)
+    end
+
+    def handle_response(response)
+      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"]}"
+      else
+        body
+      end
+    end
+  end
+end

data/lib/calendly/resources/data_compliance.rb

@@ -0,0 +1,7 @@
+module Calendly
+  class DataComplianceResource < Resource
+    def delete_invitee_data(emails:)
+      post_request("data_compliance/deletion/invitees", body: {emails: emails})
+    end
+  end
+end