knockapi 0.6.1 → 1.0.0

data/.github/workflows/publish.yml

@@ -1,17 +0,0 @@
-name: Publish Gem
-
-on:
-  push:
-    tags:
-      - v*
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: Release Gem
-        uses: cadwallion/publish-rubygems-action@master
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
-          RELEASE_COMMAND: ./bin/publish

data/.github/workflows/ruby.yml

@@ -1,47 +0,0 @@
-# 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.7", "3.0", "3.1", "3.2"]
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        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@v1
-        with:
-          bundler-cache: true
-      # Add or replace any other lints here
-      - name: Lint Ruby files
-        run: bundle exec rubocop

data/.gitignore

@@ -1,49 +0,0 @@
-*.gem
-*.rbc
-*.DS_Store
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*

data/.rubocop.yml

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

data/.ruby-version

@@ -1 +0,0 @@
-3.2.5

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.2.5

data/CONTRIBUTING.md

@@ -1,31 +0,0 @@
-# Contributing
-
-## Getting Started
-
-1. Install [asdf](https://asdf-vm.com)
-2. Install the asdf Ruby plugin
-
-```bash
-asdf plugin add ruby https://github.com/asdf-vm/asdf-ruby.git # Visit that repository to see installation prerequisites
-```
-
-3. Run `asdf install` to install the version of Ruby specified in the [.ruby-version](.ruby-version) file
-4. Run `bundle install` to install the Ruby dependencies
-
-## Running the tests
-
-```bash
-bundle exec rspec
-```
-
-## Running the linter
-
-```bash
-bundle exec rubocop
-```
-
-## Formatting
-
-```bash
-bundle exec rubocop -a
-```

data/Gemfile

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

data/Gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: .
-  specs:
-    knockapi (0.6.1)
-
-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)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.10.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.4)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.1.7)
-      rubocop (= 1.18.4)
-      rubocop-performance (= 1.11.4)
-    unicode-display_width (2.0.0)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-19
-
-DEPENDENCIES
-  bundler (>= 2.0.1)
-  knockapi!
-  rake
-  rspec (~> 3.11)
-  standard
-
-BUNDLED WITH
-   2.2.26

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 Knock Labs, Inc.
-
-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/bin/console

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

data/bin/publish

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-bundle install
-bundle exec gem build knockapi --output=release.gem
-bundle exec gem push release.gem

data/knockapi.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'knock/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'knockapi'
-  spec.version = Knock::VERSION
-  spec.authors = ['Knock Labs, Inc.']
-  spec.email = ['support@knock.app']
-  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'
-  }
-
-  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.add_development_dependency 'bundler', '>= 2.0.1'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'standard'
-
-  spec.required_ruby_version = '>= 2.5'
-end

data/lib/knock/bulk_operations.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'uri'
-
-module Knock
-  # Provides convienience methods for working with bulk operations
-  module BulkOperations
-    class << self
-      include Client
-
-      # Retrieves the given bulk operation
-      #
-      # @param [String] id The bulk operation ID
-      #
-      # @return [Hash] The bulk operation
-      def get(id:)
-        request = get_request(
-          auth: true,
-          path: "/v1/bulk_operations/#{id}"
-        )
-
-        execute_request(request: request)
-      end
-    end
-  end
-end

data/lib/knock/client.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-module Knock
-  # A Net::HTTP based API client for interacting with the Knock API
-  # rubocop:disable Metrics/ModuleLength
-  module Client
-    include Kernel
-
-    def client
-      Net::HTTP.new(Knock.config.api_hostname, 443).tap do |http_client|
-        http_client.use_ssl = true
-        http_client.open_timeout = Knock.config.timeout
-        http_client.read_timeout = Knock.config.timeout
-        http_client.write_timeout = Knock.config.timeout if RUBY_VERSION >= '2.6.0'
-      end
-    end
-
-    def execute_request(request:)
-      begin
-        response = client.request(request)
-      rescue Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout
-        raise TimeoutError.new(
-          message: 'API Timeout Error'
-        )
-      end
-
-      http_status = response.code.to_i
-      handle_error_response(response: response) if http_status >= 400
-
-      JSON.parse(response.body) if response.body && (response.body != '')
-    end
-
-    def get_request(path:, auth: false, params: {}, access_token: nil)
-      uri = URI(path)
-      uri.query = URI.encode_www_form(params) if params
-
-      request = Net::HTTP::Get.new(
-        uri.to_s,
-        'Content-Type' => 'application/json'
-      )
-
-      request['Authorization'] = "Bearer #{access_token || Knock.config.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')
-      request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{Knock.config.key!}" if auth
-      request['User-Agent'] = user_agent
-      request['Idempotency-Key'] = idempotency_key if idempotency_key
-      request
-    end
-
-    def delete_request(path:, auth: false, params: {}, body: nil)
-      uri = URI(path)
-      uri.query = URI.encode_www_form(params) if params
-
-      request = Net::HTTP::Delete.new(
-        uri.to_s,
-        'Content-Type' => 'application/json'
-      )
-
-      request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{Knock.config.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')
-      request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{Knock.config.key!}" if auth
-      request['User-Agent'] = user_agent
-      request['Idempotency-Key'] = idempotency_key if idempotency_key
-      request
-    end
-
-    def user_agent
-      "Knock Ruby - v#{Knock::VERSION}"
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
-
-    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'],
-          http_status: http_status,
-          request_id: response['x-request-id']
-        )
-      when 401
-        raise AuthenticationError.new(
-          message: json['message'],
-          http_status: http_status,
-          request_id: response['x-request-id']
-        )
-      when 404
-        raise NotFoundError.new(
-          message: json['message'],
-          http_status: http_status,
-          request_id: response['x-request-id']
-        )
-      when 422
-        message = json['message']
-        errors = extract_error(json['errors']) if json['errors']
-        message += " (#{errors})" if errors
-
-        raise UnprocessableEntityError.new(
-          message: message,
-          http_status: http_status,
-          request_id: response['x-request-id']
-        )
-      when 429
-        raise RateLimitExceededError.new(
-          message: json['message'],
-          http_status: http_status,
-          request_id: response['x-request-id']
-        )
-      else
-        raise APIError.new(
-          message: json['message'],
-          http_status: http_status,
-          request_id: response['x-request-id']
-        )
-      end
-    end
-
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/MethodLength
-
-    private
-
-    def extract_error(errors)
-      errors.map do |error|
-        "#{error['field']}: #{error['message']} (#{error['type']})"
-      end.join('; ')
-    end
-  end
-  # rubocop:enable Metrics/ModuleLength
-end

data/lib/knock/configuration.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# typed: true
-
-module Knock
-  # Configuration class sets config initializer
-  class Configuration
-    attr_accessor :api_hostname, :timeout, :key
-
-    def initialize
-      @timeout = 60
-    end
-
-    def key!
-      key or raise '`Knock.config.key` not set'
-    end
-  end
-end

data/lib/knock/errors.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Knock
-  # Knock specific errors
-  class KnockError < StandardError
-    attr_reader :http_status, :request_id
-
-    def initialize(message: nil, error: nil, error_description: nil, http_status: nil, request_id: nil)
-      super
-      @message = message
-      @error = error
-      @error_description = error_description
-      @http_status = http_status
-      @request_id = request_id
-    end
-
-    def to_s
-      status_string = @http_status.nil? ? '' : "Status #{@http_status}, "
-      id_string = @request_id.nil? ? '' : " - request ID: #{@request_id}"
-
-      if @error && @error_description
-        error_string = "error: #{@error}, error_description: #{@error_description}"
-        "#{status_string}#{error_string}#{id_string}"
-      elsif @error
-        "#{status_string}#{@error}#{id_string}"
-      else
-        "#{status_string}#{@message}#{id_string}"
-      end
-    end
-  end
-
-  # APIError is a generic error that may be raised in cases where none of the
-  # other named errors cover the problem. It could also be raised in the case
-  # that a new error has been introduced in the API, but this version of the
-  # Ruby SDK doesn't know how to handle it.
-  class APIError < KnockError; end
-
-  # AuthenticationError is raised when invalid credentials are used to connect
-  # to Knock's servers.
-  class AuthenticationError < KnockError; end
-
-  # InvalidRequestError is raised when a request is initiated with invalid
-  # parameters.
-  class InvalidRequestError < KnockError; end
-
-  # RateLimitExceededError is raised when the rate limit for the API has been hit
-  class RateLimitExceededError < KnockError; end
-
-  # NotFoundError is raised when a resource is not found
-  class NotFoundError < KnockError; end
-
-  # TimeoutError is raised when the HTTP request to the API times out
-  class TimeoutError < KnockError; end
-
-  # UnprocessableEntityError is raised when a request is made that cannot be processed
-  class UnprocessableEntityError < KnockError; end
-end

data/lib/knock/messages.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'net/http'
-require 'uri'
-
-module Knock
-  # Methods for interacting with messages in Knock
-  module Messages
-    class << self
-      include Client
-
-      # Retrieves a paginated list of messages for the provided environment
-      #
-      # @param [Hash] options Options to pass to the messages endpoint query
-      #
-      # @return [Hash] Paginated list of Message records
-      def list(options: {})
-        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
-
-        request = get_request(
-          auth: true,
-          path: '/v1/messages',
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-
-      # Retrieves a Message
-      #
-      # @param [String] id The message id
-      #
-      # @return [Hash] The Message
-      def get(id:)
-        request = get_request(
-          auth: true,
-          path: "/v1/messages/#{id}"
-        )
-
-        execute_request(request: request)
-      end
-
-      # Get a Message's content
-      #
-      # @param [String] id The message id
-      #
-      # @return [Hash] The Message content
-      def get_content(id:)
-        request = get_request(
-          auth: true,
-          path: "/v1/messages/#{id}/content"
-        )
-
-        execute_request(request: request)
-      end
-
-      # Get a Message's activities
-      #
-      # @param [String] id The message id
-      # @param [Hash] options Options to pass to the paginated activities endpoint query
-      #
-      # @return [Hash] Paginated Message's activities
-      def get_activities(id:, options: {})
-        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
-
-        request = get_request(
-          auth: true,
-          path: "/v1/messages/#{id}/activities",
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-
-      # Get a Message's events
-      #
-      # @param [String] id The message id
-      # @param [Hash] options Options to pass to the paginated events endpoint query
-      #
-      # @return [Hash] Paginated Message's events
-      def get_events(id:, options: {})
-        request = get_request(
-          auth: true,
-          path: "/v1/messages/#{id}/events",
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-    end
-  end
-end