v3 Polish: Cleanup & documentation

.gitignore

@@ -28,3 +28,4 @@ TAGS
 *.swp
 vendor/
 out
+test.rb

.rubocop.yml

@@ -2,7 +2,7 @@ inherit_from: .rubocop_todo.yml
 
 require: rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
   DisplayCopNames: true
   DisplayStyleGuide: true
   Exclude:
@@ -27,6 +27,7 @@ Metrics/ParameterLists:
     - "lib/nylas/calendar_collection.rb"
 
 Metrics/MethodLength:
+  Max: 20
   Exclude:
     - "lib/nylas/calendar_collection.rb"
     - "lib/nylas/services/tunnel.rb"
@@ -36,6 +37,7 @@ Metrics/AbcSize:
     - "lib/nylas/services/tunnel.rb"
 
 Metrics/ModuleLength:
+  Max: 200
   Exclude:
     - "lib/nylas/model.rb"
 

.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--exclude lib/nylas/handler/api_operations.rb
+--exclude lib/nylas/handler/http_client.rb
+--exclude lib/nylas/resources/base_resource.rb
+lib/**/*.rb

README.md

@@ -24,10 +24,8 @@ If you have a question that needs an answer, please reach out to support@nylas.c
 
 ## ⚙️ Install
 ### Prerequisites
-- Ruby 2.3 or above.
-- Ruby Frameworks: `rest-client`, `json`, `yajl-ruby`.
-
-We support Rails 4.2 and above. A more detailed compatibility list can be found in our [list of Gemfiles](https://github.com/nylas/nylas-ruby/tree/master/gemfiles).
+- Ruby 3.0 or above.
+- Ruby Frameworks: `rest-client` and `yajl-ruby`.
 
 ### Install
 
@@ -93,26 +91,22 @@ To use this SDK, you first need to [sign up for a free Nylas developer account](
 
 Then, follow our guide to [setup your first app and get your API access keys](https://docs.nylas.com/docs/get-your-developer-api-keys).
 
-All of the functionality of the Nylas Communications Platform is available through the `API` object. To access data for an account that’s connected to Nylas, create a new API client object and pass the variables you gathered when you got your developer API keys. In the following example, replace `CLIENT_ID`, `CLIENT_SECRET`, and `ACCESS_TOKEN` with your values.
+All of the functionality of the Nylas Communications Platform is available through the `API` object. To access data for an account that’s connected to Nylas, create a new API client object and pass the variables you gathered when you got your developer API keys. In the following example, replace `API_KEY` with your Nylas API Key, and optionally fill in the rest of the configuration.
 
 
 ```ruby
 require 'nylas'
 
 nylas = Nylas::API.new(
-    app_id: CLIENT_ID,
-    app_secret: CLIENT_SECRET,
-    access_token: ACCESS_TOKEN
+  api_key: API_KEY,
+  client_id: CLIENT_ID, # Optional
+  client_secret: CLIENT_SECRET, # Optional
+  host: DEFAULT_REGION_URL, # Optional
+  timeout: TIMEOUT # Optional
 )
 ```
 
-Now, you can use `nylas` to access full email, calendar, and contacts functionality. For example, here is how you would print the subject line for the most recent email message to the console.
-
-
-```ruby
-message = nylas.messages.first
-puts(message.subject)
-```
+Now, you can use `nylas` to access full email, calendar, and contacts functionality.
 
 To learn more about how to use the Nylas Ruby SDK, please refer to our [Ruby](https://docs.nylas.com/docs/quickstart-ruby) [SDK QuickStart Guide](https://docs.nylas.com/docs/quickstart-ruby).
 

gem_config.rb

@@ -4,55 +4,45 @@
 
 # Consistently apply nylas' standard gem data across gems
 module GemConfig
-  def self.apply(gem, name)
-    gem.name = name
-    gem.files = Dir.glob("lib/{#{name}.rb,#{name}/**/*.rb}")
+  def self.apply(gem)
+    gem.description = %(Gem for interacting with the Nylas API.)
+    gem.files = Dir.glob("lib/{nylas.rb,nylas/**/*.rb}")
     gem.license = "MIT"
     gem.version = Nylas::VERSION
     gem.platform = "ruby"
     gem.required_ruby_version = ">= 3.0"
-    append_nylas_data(gem)
-    dev_dependencies.each do |dependency|
-      gem.add_development_dependency(*dependency)
-    end
-  end
-
-  def self.append_nylas_data(gem)
     gem.metadata = metadata
     gem.email = "support@nylas.com"
     gem.authors = ["Nylas, Inc."]
+    dev_dependencies.each do |dependency|
+      gem.add_development_dependency(*dependency)
+    end
   end
 
   def self.metadata
     {
       "bug_tracker_uri" => "https://github.com/nylas/nylas-ruby/issues",
       "changelog_uri" => "https://github.com/nylas/nylas-ruby/blob/master/CHANGELOG.md",
-      "documentation_uri" => "http://www.rubydoc.info/gems/nylas",
+      "documentation_uri" => "https://developer.nylas.com/docs/sdks/ruby/",
       "homepage_uri" => "https://www.nylas.com",
       "source_code_uri" => "https://github.com/nylas/nylas-ruby",
-      "wiki_uri" => "https://github.com/nylas/nylas-ruby/wiki"
+      "github_repo" => "https://github.com/nylas/nylas-ruby"
     }
   end
 
   def self.dev_dependencies
     [["bundler", ">= 1.3.0"],
-     ["yard", "~> 0.9.0"],
-     ["awesome_print", "~> 1.0"],
-     ["rubocop", "~> 1.24.1"],
-     ["rubocop-rspec", "~> 2.7.0"],
-     ["overcommit", "~> 0.41"]] + testing_and_debugging_dependencies
+     ["yard", "~> 0.9.34"],
+     ["rubocop", "~> 1.51"],
+     ["rubocop-rspec", "~> 2.22"]] + testing_and_debugging_dependencies
   end
 
   def self.testing_and_debugging_dependencies
-    [["pry", "~>  0.14.1"],
-     ["pry-nav", "~> 1.0.0"],
-     ["pry-stack_explorer", "~> 0.4.9.3"],
-     ["rspec", "~> 3.7"],
-     ["rspec-json_matcher", "~> 0.1"],
-     ["webmock", "~> 3.0"],
-     ["faker", "~> 1.8"],
-     ["informed", "~> 1.0"],
+    [["rspec", "~> 3.12"],
+     ["rspec-json_matcher", "~> 0.2.0"],
+     ["webmock", "~> 3.18", ">= 3.18.1"],
      ["simplecov", "~> 0.21.2"],
-     ["simplecov-cobertura", "~> 2.1.0"]]
+     ["simplecov-cobertura", "~> 2.1.0"],
+     ["webrick", "~> 1.8", ">= 1.8.1"]]
   end
 end

lib/nylas.rb

@@ -7,26 +7,30 @@
 #   See https://github.com/sparklemotion/http-cookie/issues/27
 #   and https://github.com/sparklemotion/http-cookie/issues/6
 #
-# CookieJar uses unsafe class caching for dynamically loading cookie jars
-# If 2 rest-client instances are instantiated at the same time, (in threads)
-# non-deterministic behaviour can occur whereby the Hash cookie jar isn't
-# properly loaded and cached.
-# Forcing an instantiation of the jar onload will force the CookieJar to load
-# before the system has a chance to spawn any threads.
-# Note this should technically be fixed in rest-client itself however that
-# library appears to be stagnant so we're forced to fix it here
-# This object should get GC'd as it's not referenced by anything
+# CookieJar uses unsafe class caching for dynamically loading cookie jars. 
+# If two rest-client instances are instantiated at the same time (in threads), non-deterministic
+# behaviour can occur whereby the Hash cookie jar isn't properly loaded and cached.
+# Forcing an instantiation of the jar onload will force the CookieJar to load before the system has
+# a chance to spawn any threads.
+# Note that this should technically be fixed in rest-client itself, however that library appears to
+# be stagnant so we're forced to fix it here.
+# This object should get GC'd as it's not referenced by anything.
 HTTP::CookieJar.new
 
 require "ostruct"
 require "forwardable"
 
 require_relative "nylas/version"
 require_relative "nylas/errors"
+require_relative "nylas/client"
+require_relative "nylas/config"
 
-require_relative "nylas/operations/http_client"
-require_relative "nylas/operations/api_operations"
+require_relative "nylas/handler/http_client"
 
-require_relative "nylas/resources/base_resource"
+require_relative "nylas/resources/applications"
+require_relative "nylas/resources/auth"
 require_relative "nylas/resources/calendars"
 require_relative "nylas/resources/events"
+require_relative "nylas/resources/grants"
+require_relative "nylas/resources/redirect_uris"
+require_relative "nylas/resources/webhooks"

lib/nylas/client.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "resources/calendars"
+require_relative "resources/events"
+require_relative "resources/auth"
+require_relative "resources/webhooks"
+require_relative "resources/applications"
+
+module Nylas
+  # Methods to retrieve data from the Nylas API as Ruby objects.
+  class Client
+    attr_reader :api_key, :host, :timeout
+
+    # Initializes a client session.
+    #
+    # @param api_key [Hash, nil] API key to use for the client session.
+    # @param host [Hash] Client session's host.
+    # @param timeout [Hash, nil] Timeout value to use for the client session.
+    def initialize(api_key: nil,
+                   host: Config::DEFAULT_REGION_URL,
+                   timeout: nil)
+      @api_key = api_key
+      @host = host
+      @timeout = timeout
+    end
+
+    # The application resources for your Nylas application.
+    #
+    # @return [Nylas::Applications] Application resources for your Nylas application.
+    def applications
+      Applications.new(self)
+    end
+
+    # The calendar resources for your Nylas application.
+    #
+    # @return [Nylas::Calendars] Calendar resources for your Nylas application.
+    def calendars
+      Calendars.new(self)
+    end
+
+    # The event resources for your Nylas application.
+    #
+    # @return [Nylas::Events] Event resources for your Nylas application
+    def events
+      Events.new(self)
+    end
+
+    # The auth resources for your Nylas application.
+    #
+    # @return [Nylas::Auth] Auth resources for your Nylas application.
+    def auth
+      Auth.new(self)
+    end
+
+    # The webhook resources for your Nylas application.
+    #
+    # @return [Nylas::Webhooks] Webhook resources for your Nylas application.
+    def webhooks
+      Webhooks.new(self)
+    end
+  end
+end

lib/nylas/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Configuration options for the Nylas Ruby SDK.
+  module Config
+    # The configuration options for supported regions.
+    REGION_CONFIG = {
+      us: {
+        nylas_api_url: "https://api.us.nylas.com"
+      },
+      eu: {
+        nylas_api_url: "https://api.eu.nylas.com"
+      }
+    }.freeze
+
+    # The default API endpoint for the Nylas API.
+    DEFAULT_REGION_URL = REGION_CONFIG[:us][:nylas_api_url]
+  end
+end