ngrok-api 0.9.0

data/spec/ngrokapi/services/api_keys_client_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::ApiKeysClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/api_keys' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: api_key_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @api_keys_client = NgrokAPI::Services::ApiKeysClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a POST request and return a newly created instance of NgrokAPI::Models::ApiKey" do
+      merged = api_key_result
+      merged['metadata'] = 'data'
+      expect(@client).to receive(:post).with(path, data: { metadata: 'data' }).and_return(merged)
+      result2 = @api_keys_client.create(metadata: 'data')
+      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
+      expect(result2.id).to eq(api_key_result["id"])
+      expect(result2.metadata).to eq('data')
+    end
+  end
+
+  describe "#delete" do
+    it "will make a DELETE request" do
+      expect(@client).to receive(:delete).with("#{path}/#{api_key_result["id"]}").and_return(nil)
+      @api_keys_client.delete(id: api_key_result["id"])
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a DELETE request" do
+      expect(@client).to receive(:delete).with("#{path}/#{api_key_result["id"]}", danger: true).
+        and_return(nil)
+      @api_keys_client.delete!(id: api_key_result["id"])
+    end
+
+    it "will make a DELETE request and return NotFoundError if 404" do
+      expect do
+        expect(@client).to receive(:delete).with("#{path}/#{api_key_result["id"]}", danger: true).
+          and_raise(NgrokAPI::Errors::NotFoundError)
+        result2 = @api_keys_client.delete!(id: api_key_result["id"])
+        expect(result2).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+
+  describe "#get" do
+    it "will make a GET request and return a NgrokAPI::Models::ApiKey" do
+      expect(@client).to receive(:get).with("#{path}/#{api_key_result["id"]}").and_return(api_key_result)
+      result2 = @api_keys_client.get(id: api_key_result["id"])
+      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
+      expect(result2.id).to eq(api_key_result["id"])
+    end
+  end
+
+  describe "#get!" do
+    it "will make a GET request and return a NgrokAPI::Models::ApiKey" do
+      expect(@client).to receive(:get).with("#{path}/#{api_key_result["id"]}", danger: true).and_return(api_key_result)
+      result2 = @api_keys_client.get!(id: api_key_result["id"])
+      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
+      expect(result2.id).to eq(api_key_result["id"])
+    end
+
+    it "will make a GET request and return NotFoundError if 404" do
+      expect do
+        expect(@client).to receive(:get).with("#{path}/#{api_key_result["id"]}", danger: true).
+          and_raise(NgrokAPI::Errors::NotFoundError)
+        result2 = @api_keys_client.get!(id: api_key_result["id"])
+        expect(result2).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+
+  describe "#list" do
+    it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
+      expect(@client).to receive(:list).and_return(api_key_results)
+      url = "#{base_url}#{path}?before_id=#{api_key_result["id"]}&limit=1"
+      result2 = @api_keys_client.list(url: url)
+      expect(result2.class).to eq(NgrokAPI::Models::Listable)
+      expect(result2.items.first.id).to eq(api_key_result["id"])
+    end
+  end
+
+  describe "#update" do
+    it "will make a PATCH request and return an updated instance of NgrokAPI::Models::ApiKey" do
+      merged = api_key_result
+      merged['metadata'] = 'data'
+      expect(@client).to receive(:patch).
+        with("#{path}/#{api_key_result["id"]}", data: { metadata: 'data' }).
+        and_return(merged)
+      result2 = @api_keys_client.update(id: api_key_result["id"], metadata: 'data')
+      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
+      expect(result2.id).to eq(api_key_result["id"])
+      expect(result2.metadata).to eq('data')
+    end
+  end
+
+  describe "#update!" do
+    it "will make a PATCH request and return an updated instance of NgrokAPI::Models::ApiKey" do
+      merged = api_key_result
+      merged['metadata'] = 'data'
+      expect(@client).to receive(:patch).
+        with("#{path}/#{api_key_result["id"]}", danger: true, data: { metadata: 'data' }).
+        and_return(merged)
+      result2 = @api_keys_client.update!(id: api_key_result["id"], metadata: 'data')
+      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
+      expect(result2.id).to eq(api_key_result["id"])
+      expect(result2.metadata).to eq('data')
+    end
+
+    it "will make a PATCH request and return NotFoundError if 404" do
+      expect do
+        merged = api_key_result
+        merged['metadata'] = 'data'
+        expect(@client).to receive(:patch).
+          with("#{path}/#{api_key_result["id"]}", danger: true, data: { metadata: 'data' }).
+          and_raise(NgrokAPI::Errors::NotFoundError)
+        result2 = @api_keys_client.update!(id: api_key_result["id"], metadata: 'data')
+        expect(result2).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+require 'pry'
+
+require 'webmock/rspec'
+require './lib/ngrokapi'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each do |f|
+  require f
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = false
+  end
+
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end
+
+RSpec::Matchers.define :use_ssl do
+  match(&:use_ssl?)
+end
+
+RSpec::Matchers.define :use_cert_store do |cert_store|
+  match do |connection|
+    connection.cert_store == cert_store
+  end
+end
+
+# Custom objects
+def api_key_result
+  {
+    "id" => "ak_1xrq8h890dWRYiRdIHeZYCdlyT7",
+    "uri" => "https://api.ngrok.com/api_keys/ak_1xrq8h890dWRYiRdIHeZYCdlyT7",
+    "description" => "",
+    "metadata" => "",
+    "created_at" => "2021-09-08T17:49:56Z",
+    "token" => nil,
+  }
+end
+
+def api_key_result2
+  {
+    "id" => "ak_1xrqAsg8fMHBgD71MSbtr6a0pA2",
+    "uri" => "https://api.ngrok.com/api_keys/ak_1xrqAsg8fMHBgD71MSbtr6a0pA2",
+    "description" => "",
+    "metadata" => "",
+    "created_at" => "2021-09-08T17:50:14Z",
+    "token" => nil,
+  }
+end
+
+def api_key_results
+  {
+    "keys" => [
+      api_key_result,
+      api_key_result2,
+    ],
+    "uri" => "https://api.ngrok.com/api_keys",
+    "next_page_uri" => nil,
+  }
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: ngrok-api
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- ''
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-24 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
+      it easier to consume in Ruby.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_airbnb.yml"
+- ".simplecov"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- doc/NgrokAPI.html
+- doc/NgrokAPI/Client.html
+- doc/NgrokAPI/Error.html
+- doc/NgrokAPI/Errors.html
+- doc/NgrokAPI/Errors/NotFoundError.html
+- doc/NgrokAPI/HttpClient.html
+- doc/NgrokAPI/Models.html
+- doc/NgrokAPI/Models/ApiKey.html
+- doc/NgrokAPI/Models/EndpointConfiguration.html
+- doc/NgrokAPI/Models/Listable.html
+- doc/NgrokAPI/Models/ReservedDomain.html
+- doc/NgrokAPI/Models/TlsCertificate.html
+- doc/NgrokAPI/PagedIterator.html
+- doc/NgrokAPI/Services.html
+- doc/NgrokAPI/Services/ApiKeysClient.html
+- doc/NgrokAPI/Services/EndpointConfigurationsClient.html
+- doc/NgrokAPI/Services/ReservedDomainsClient.html
+- doc/NgrokAPI/Services/TlsCertificatesClient.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- docs/NgrokAPI.html
+- docs/NgrokAPI/Client.html
+- docs/NgrokAPI/Error.html
+- docs/NgrokAPI/Errors.html
+- docs/NgrokAPI/Errors/NotFoundError.html
+- docs/NgrokAPI/HttpClient.html
+- docs/NgrokAPI/Models.html
+- docs/NgrokAPI/Models/ApiKey.html
+- docs/NgrokAPI/Models/EndpointConfiguration.html
+- docs/NgrokAPI/Models/Listable.html
+- docs/NgrokAPI/Models/ReservedDomain.html
+- docs/NgrokAPI/Models/TlsCertificate.html
+- docs/NgrokAPI/PagedIterator.html
+- docs/NgrokAPI/Services.html
+- docs/NgrokAPI/Services/ApiKeysClient.html
+- docs/NgrokAPI/Services/EndpointConfigurationsClient.html
+- docs/NgrokAPI/Services/ReservedDomainsClient.html
+- docs/NgrokAPI/Services/TlsCertificatesClient.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
+- lib/ngrokapi.rb
+- lib/ngrokapi/client.rb
+- lib/ngrokapi/error.rb
+- lib/ngrokapi/errors/not_found_error.rb
+- lib/ngrokapi/http_client.rb
+- lib/ngrokapi/models/api_key.rb
+- lib/ngrokapi/models/endpoint_configuration.rb
+- lib/ngrokapi/models/listable.rb
+- lib/ngrokapi/models/reserved_domain.rb
+- lib/ngrokapi/models/tls_certificate.rb
+- lib/ngrokapi/paged_iterator.rb
+- lib/ngrokapi/services/api_keys_client.rb
+- lib/ngrokapi/services/endpoint_configurations_client.rb
+- lib/ngrokapi/services/reserved_domains_client.rb
+- lib/ngrokapi/services/tls_certificates_client.rb
+- lib/ngrokapi/version.rb
+- ngrok-api.gemspec
+- spec/ngrokapi/client_spec.rb
+- spec/ngrokapi/http_client_spec.rb
+- spec/ngrokapi/models/api_key_spec.rb
+- spec/ngrokapi/models/listable_spec.rb
+- spec/ngrokapi/models/reserved_domain_spec.rb
+- spec/ngrokapi/paged_iterator_spec.rb
+- spec/ngrokapi/services/api_keys_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ngrok/ngrok-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
+  it easier to consume in Ruby.
+test_files: []