chore(kno-1566): add tenants functions (#6)

Author: meryldakin

.github/workflows/ruby.yml

@@ -0,0 +1,52 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec spec
+
+  lint:
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@8f312efe1262fb463d906e9bf040319394c18d3e # v1.92
+        with:
+          bundler-cache: true
+      # Add or replace any other lints here
+      - name: Lint Ruby files
+        run: bundle exec rubocop

.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.5
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 35
+Metrics/ParameterLists:
+  Max: 6

Gemfile

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'rspec', '~> 3.11'
+end

Gemfile.lock

@@ -7,13 +7,27 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    diff-lcs (1.5.0)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (1.18.4)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -42,6 +56,7 @@ DEPENDENCIES
   bundler (>= 2.0.1)
   knockapi!
   rake
+  rspec (~> 3.11)
   standard
 
 BUNDLED WITH

bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "knock"
+require 'bundler/setup'
+require 'knock'
 
-require "irb"
-IRB.start(__FILE__)
+require 'irb'
+IRB.start(__FILE__)

knockapi.gemspec

@@ -1,30 +1,30 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "knock/version"
+require 'knock/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "knockapi"
+  spec.name = 'knockapi'
   spec.version = Knock::VERSION
-  spec.authors = ["Knock Labs, Inc."]
-  spec.email = ["[email protected]"]
-  spec.description = "API client for Knock"
-  spec.summary = "API client for Knock"
-  spec.homepage = "https://github.com/knocklabs/knock-ruby"
-  spec.license = "MIT"
+  spec.authors = ['Knock Labs, Inc.']
+  spec.email = ['[email protected]']
+  spec.description = 'API client for Knock'
+  spec.summary = 'API client for Knock'
+  spec.homepage = 'https://github.com/knocklabs/knock-ruby'
+  spec.license = 'MIT'
   spec.metadata = {
-    "documentation_uri" => "https://docs.knock.app"
+    'documentation_uri' => 'https://docs.knock.app'
   }
 
   spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", ">= 2.0.1"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "standard"
+  spec.add_development_dependency 'bundler', '>= 2.0.1'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'standard'
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = '>= 2.5'
 end

lib/knock.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require "knock/version"
-require "json"
+require 'knock/version'
+require 'json'
 
+# Setup for Knock client
 module Knock
-  API_HOSTNAME = ENV["KNOCK_API_HOSTNAME"] || "api.knock.app"
+  API_HOSTNAME = ENV['KNOCK_API_HOSTNAME'] || 'api.knock.app'
 
   def self.key=(value)
     Base.key = value
@@ -15,26 +16,27 @@ def self.key
   end
 
   def self.key!
-    key || raise("Knock.key not set")
+    key || raise('Knock.key not set')
   end
 
-  autoload :Base, "knock/base"
-  autoload :Client, "knock/client"
+  autoload :Base, 'knock/base'
+  autoload :Client, 'knock/client'
 
   # Resources
-  autoload :Preferences, "knock/preferences"
-  autoload :Users, "knock/users"
-  autoload :Workflows, "knock/workflows"
-  autoload :BulkOperations, "knock/bulk_operations"
-  autoload :Objects, "knock/objects"
-  autoload :Messages, "knock/messages"
+  autoload :Preferences, 'knock/preferences'
+  autoload :Users, 'knock/users'
+  autoload :Workflows, 'knock/workflows'
+  autoload :BulkOperations, 'knock/bulk_operations'
+  autoload :Objects, 'knock/objects'
+  autoload :Tenants, 'knock/tenants'
+  autoload :Messages, 'knock/messages'
 
   # Errors
-  autoload :APIError, "knock/errors"
-  autoload :AuthenticationError, "knock/errors"
-  autoload :InvalidRequestError, "knock/errors"
+  autoload :APIError, 'knock/errors'
+  autoload :AuthenticationError, 'knock/errors'
+  autoload :InvalidRequestError, 'knock/errors'
 
-  key = ENV["KNOCK_API_KEY"]
+  key = ENV['KNOCK_API_KEY']
   Knock.key = key unless key.nil?
 
   # Triggers the workflow with the given key

lib/knock/base.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 module Knock
   ## The Base class handles setting and reading the Knock API Key for authentication
   module Base
     attr_accessor :key
 
     class << self
-      attr_writer :key
-      attr_reader :key
+      attr_accessor :key
     end
   end
 end

lib/knock/bulk_operations.rb

@@ -1,5 +1,7 @@
-require "net/http"
-require "uri"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
 
 module Knock
   # Provides convienience methods for working with bulk operations

lib/knock/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Knock
   # A Net::HTTP based API client for interacting with the Knock API
   module Client
@@ -18,9 +20,7 @@ def execute_request(request:)
       http_status = response.code.to_i
       handle_error_response(response: response) if http_status >= 400
 
-      if response.body and response.body != "" do
-        JSON.parse(response.body) 
-      end
+      JSON.parse(response.body) if response.body && (response.body != '')
     end
 
     def get_request(path:, auth: false, params: {}, access_token: nil)
@@ -29,19 +29,19 @@ def get_request(path:, auth: false, params: {}, access_token: nil)
 
       request = Net::HTTP::Get.new(
         uri.to_s,
-        "Content-Type" => "application/json"
+        'Content-Type' => 'application/json'
       )
 
-      request["Authorization"] = "Bearer #{access_token || Knock.key!}" if auth
-      request["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{access_token || Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
-    def post_request(path:, auth: false, idempotency_key: nil, body: nil)
-      request = Net::HTTP::Post.new(path, "Content-Type" => "application/json")
+    def post_request(path:, auth: false, _idempotency_key: nil, body: nil)
+      request = Net::HTTP::Post.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
-      request["Authorization"] = "Bearer #{Knock.key!}" if auth
-      request["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
@@ -51,68 +51,72 @@ def delete_request(path:, auth: false, params: {})
 
       request = Net::HTTP::Delete.new(
         uri.to_s,
-        "Content-Type" => "application/json"
+        'Content-Type' => 'application/json'
       )
 
-      request["Authorization"] = "Bearer #{Knock.key!}" if auth
-      request["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
-    def put_request(path:, auth: false, idempotency_key: nil, body: nil)
-      request = Net::HTTP::Put.new(path, "Content-Type" => "application/json")
+    def put_request(path:, auth: false, _idempotency_key: nil, body: nil)
+      request = Net::HTTP::Put.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
-      request["Authorization"] = "Bearer #{Knock.key!}" if auth
-      request["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
     def user_agent
       "Knock Ruby - v#{Knock::VERSION}"
     end
 
+    # rubocop:disable Metrics/AbcSize
+
     def handle_error_response(response:)
       http_status = response.code.to_i
       json = JSON.parse(response.body)
 
       case http_status
       when 400
         raise InvalidRequestError.new(
-          message: json["message"],
+          message: json['message'],
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       when 401
         raise AuthenticationError.new(
-          message: json["message"],
+          message: json['message'],
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       when 404
         raise APIError.new(
-          message: json["message"],
+          message: json['message'],
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       when 422
-        message = json["message"]
-        errors = extract_error(json["errors"]) if json["errors"]
+        message = json['message']
+        errors = extract_error(json['errors']) if json['errors']
         message += " (#{errors})" if errors
 
         raise InvalidRequestError.new(
           message: message,
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       end
     end
 
+    # rubocop:enable Metrics/AbcSize
+
     private
 
     def extract_error(errors)
       errors.map do |error|
-        "#{error["field"]}: #{error["message"]} (#{error["type"]})"
-      end.join("; ")
+        "#{error['field']}: #{error['message']} (#{error['type']})"
+      end.join('; ')
     end
   end
 end