render_api 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f518a70ad78745e3ef73b6010b68fe7fd9bd49f6bd57b2a2ca0ce7ec63c9e059
-  data.tar.gz: d441fd7e1962cc2727a8bcaa1e2d1040c6a4352c2d2dc818e58919ebb2653a6c
+  metadata.gz: e60203a26915978738cb41b060ef2a42ce12962620089d6e659ceac993d377a5
+  data.tar.gz: 6d281ee2af336fadbcfbd516741411b77d3757d4f4c98936273fe82d0d1015a8
 SHA512:
-  metadata.gz: 432e9f31a2e42d761bcd2b65c7a1cbe3ee4cf5d2ebfd386d0f240dceca7dc9d852f4405b49382ec11990118440370c278034b0f8c3f10cc50d4bace402033a2d
-  data.tar.gz: 2afd4b56be70de6e0819cce4278c8d997392d8e4a148eb9d513308d96c7cc3fbbd67006896ea976b60f09e278b14951477ab9b48344da31a3ae754ede065d6cc
+  metadata.gz: 0725a90c1e5f4c3463a0aa5a1bd30807712173d44ae7d388a517a2162bfd353195c0a4bee15a7d1232c6c2e0916a10f3aaf07832527738f1b3985d0a73a09576
+  data.tar.gz: a0bad23caf3be98815da38b35e8be32300bdc2bf1e420df9c4c56dbae095c28b22344f3807b12eb4d62a500617dde05c670526d71f513b609d31b04035606646

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.1.0] - 2022-05-29
+
+- Ensure POST data is sent as JSON with camelCased keys (David Mauskop).
+- Add support for job endpoints (David Mauskop).
+- Add support for domain endpoints.
+- Add support for all remaining service endpoints.
+
 ## [0.0.1] - 2021-12-12
 
 - Initial release

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby interface for [the render.com API](https://render.com/docs/api).
 
-**Please note**: this gem is currently a proof-of-concept and does not support all of the API's endpoints yet - what's covered below in Usage is what's available right now. Full support is definitely the plan, and pull requests are welcome.
+At this point in time all known API endpoints are supported.
 
 ## Installation
 
@@ -22,11 +22,92 @@ Or install it yourself as:
 
 ## Usage
 
+Returned response objects can be enumerated upon when a list of records are returned, and also can provide rate-limit details via `rate_limit`, `rate_limit_remaining`, and `rate_limit_reset` methods.
+
+The response objects respond to underscored versions of the attribute names - e.g. a service responds to `auto_deploy` with the value from the underlying hash for the key `autoDeploy`. Timestamp strings are automatically converted to Time objects, and nested hashes are also provided as these utility objects.
+
+Also: when the response objects are from a list, they respond to `cursor`, for use with pagination.
+
+### Creating a client
+
 ```ruby
 client = RenderAPI.client(api_key)
+```
+
+### Services
+
+```ruby
 client.services.list(limit: nil, cursor: nil, filters: nil)
+client.services.find(service_id)
+```
+
+```ruby
+services = client.services.list(limit: 20)
+
+puts services.rate_limit, services.rate_limit_remaining
+
+services.each do |service|
+  puts service.id
+  puts service.cursor
+  puts service.service_details.build_command
+end
+
+# https://api-docs.render.com/reference/create-service
+client.services.create(name: "my-new-service", ...)
+# https://api-docs.render.com/reference/update-service
+client.services.update(service_id, name: "my-new-service", ...)
+client.services.delete(service_id)
+
+client.services.suspend(service_id)
+client.services.resume(service_id)
+client.services.scale(service_id, num_instances: 5)
+
+client.services.list_headers(service_id, limit: nil, cursor: nil, filters: nil)
+client.services.list_routes(service_id, limit: nil, cursor: nil, filters: nil)
+client.services.list_variables(service_id, limit: nil, cursor: nil)
+# Note that updating variables requires all variables to be provided.
+# https://api-docs.render.com/reference/update-env-vars-for-service
+# (i.e. a full update, not a partial update)
+client.services.update_variables(
+  service_id,
+  [
+    { key: "RAILS_ENV", value: "production" },
+    { key: "RAILS_SESSION_SECRET", generate_value: "yes" }
+  ]
+)
+```
+
+### Deploys
+
+```ruby
 client.deploys.list(service_id, limit: nil, cursor: nil, filters: nil)
 client.deploys.create(service_id, clear_cache: "do_not_clear")
+client.deploys.find(service_id, deploy_id)
+```
+
+### Domains
+
+```ruby
+client.domains.list(service_id, limit: nil, cursor: nil, filters: nil)
+client.domains.create(service_id, name: "example.com")
+client.domains.find(service_id, domain_id)
+client.domains.verify(service_id, domain_id)
+client.domains.delete(service_id, domain_id)
+```
+
+## Owners
+
+```ruby
+client.owners.list(limit: nil, cursor: nil, filters: nil)
+client.owners.find(owner_id)
+```
+
+## Jobs
+
+```ruby
+client.jobs.list(service_id, limit: nil, cursor: nil, filters: nil)
+client.jobs.create(service_id, start_command: "whoami")
+client.jobs.find(service_id, job_id)
 ```
 
 ## Development

data/lib/render_api/camelise.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RenderAPI
+  # Borrowed from awrence:
+  # https://github.com/technicalpanda/awrence/blob/main/lib/awrence/methods.rb
+  class Camelise
+    def self.call(...)
+      new.call(...)
+    end
+
+    def call(string, first_upper: false)
+      if first_upper
+        string = gsubbed(string, /(?:^|_)([^_\s]+)/)
+        gsubbed(string, %r{/([^/]*)}, "::")
+      else
+        parts = string.split("_", 2)
+        parts[0] << call(parts[1], first_upper: true) if parts.size > 1
+        parts[0] || ""
+      end
+    end
+
+    private
+
+    def gsubbed(string, pattern, extra = "")
+      string.gsub(pattern) { extra + Regexp.last_match(1).capitalize }
+    end
+  end
+end

data/lib/render_api/client.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "./clients/deploys"
+require_relative "./clients/domains"
+require_relative "./clients/jobs"
+require_relative "./clients/owners"
 require_relative "./clients/services"
 require_relative "./endpoint"
 
@@ -14,6 +17,18 @@ module RenderAPI
       @deploys ||= Clients::Deploys.new(endpoint)
     end
 
+    def domains
+      @domains ||= Clients::Domains.new(endpoint)
+    end
+
+    def jobs
+      @jobs ||= Clients::Jobs.new(endpoint)
+    end
+
+    def owners
+      @owners ||= Clients::Owners.new(endpoint)
+    end
+
     def services
       @services ||= Clients::Services.new(endpoint)
     end

data/lib/render_api/clients/deploys.rb

@@ -14,6 +14,12 @@ module RenderAPI
         )
       end
 
+      def find(service_id, deploy_id)
+        endpoint.get(
+          "/services/#{service_id}/deploys/#{deploy_id}"
+        )
+      end
+
       def list(service_id, ...)
         endpoint.get(
           "/services/#{service_id}/deploys", params: list_parameters(...)

data/lib/render_api/clients/domains.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+
+module RenderAPI
+  module Clients
+    class Domains < Base
+      def create(service_id, name:)
+        endpoint.post(
+          "/services/#{service_id}/custom-domains", body: { name: name }
+        )
+      end
+
+      def delete(service_id, domain_id)
+        endpoint.delete(
+          "/services/#{service_id}/custom-domains/#{domain_id}"
+        )
+      end
+
+      def find(service_id, domain_id)
+        endpoint.get(
+          "/services/#{service_id}/custom-domains/#{domain_id}"
+        )
+      end
+
+      def list(service_id, ...)
+        endpoint.get(
+          "/services/#{service_id}/custom-domains", params: list_parameters(...)
+        )
+      end
+
+      def verify(service_id, domain_id)
+        endpoint.post(
+          "/services/#{service_id}/custom-domains/#{domain_id}/verify"
+        )
+      end
+    end
+  end
+end

data/lib/render_api/clients/jobs.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+
+module RenderAPI
+  module Clients
+    class Jobs < Base
+      def create(service_id, start_command:, plan_id: nil)
+        body = { startCommand: start_command }
+        body[:plan_id] = plan_id unless plan_id.nil?
+
+        endpoint.post(
+          "/services/#{service_id}/jobs", body: body
+        )
+      end
+
+      def find(service_id, job_id)
+        endpoint.get(
+          "/services/#{service_id}/jobs/#{job_id}"
+        )
+      end
+
+      def list(service_id, ...)
+        endpoint.get(
+          "/services/#{service_id}/jobs", params: list_parameters(...)
+        )
+      end
+    end
+  end
+end

data/lib/render_api/clients/owners.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+
+module RenderAPI
+  module Clients
+    class Owners < Base
+      def find(owner_id)
+        endpoint.get("/owners/#{owner_id}")
+      end
+
+      def list(...)
+        endpoint.get("/owners", params: list_parameters(...))
+      end
+    end
+  end
+end

data/lib/render_api/clients/services.rb

@@ -5,9 +5,62 @@ require_relative "./base"
 module RenderAPI
   module Clients
     class Services < Base
+      def create(**payload)
+        endpoint.post("/services", body: payload)
+      end
+
+      def delete(service_id)
+        endpoint.delete("/services/#{service_id}")
+      end
+
+      def find(service_id)
+        endpoint.get("/services/#{service_id}")
+      end
+
       def list(...)
         endpoint.get("/services", params: list_parameters(...))
       end
+
+      def list_headers(service_id, ...)
+        endpoint.get(
+          "/services/#{service_id}/headers", params: list_parameters(...)
+        )
+      end
+
+      def list_routes(service_id, ...)
+        endpoint.get(
+          "/services/#{service_id}/routes", params: list_parameters(...)
+        )
+      end
+
+      def list_variables(service_id, ...)
+        endpoint.get(
+          "/services/#{service_id}/env-vars", params: list_parameters(...)
+        )
+      end
+
+      def resume(service_id)
+        endpoint.post("/services/#{service_id}/resume")
+      end
+
+      def scale(service_id, num_instances:)
+        endpoint.post(
+          "/services/#{service_id}/scale",
+          body: { num_instances: num_instances }
+        )
+      end
+
+      def suspend(service_id)
+        endpoint.post("/services/#{service_id}/suspend")
+      end
+
+      def update(service_id, **payload)
+        endpoint.patch("/services/#{service_id}", body: payload)
+      end
+
+      def update_variables(service_id, payloads)
+        endpoint.put("/services/#{service_id}/env-vars", body: payloads)
+      end
     end
   end
 end

data/lib/render_api/data_object.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "./camelise"
+
+module RenderAPI
+  class DataObject
+    TIME_PATTERN = /\A\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\d+Z\z/.freeze
+
+    attr_reader :cursor
+
+    def initialize(data)
+      if data["cursor"]
+        @cursor = data.delete("cursor")
+        @data = data.values.first
+      else
+        @data = data
+      end
+    end
+
+    def to_h
+      data
+    end
+
+    private
+
+    attr_reader :data
+
+    def method_missing(name, *args, **kwargs, &block)
+      return super unless respond_to_missing?(name, false)
+      raise ArgumentError if args.any? || kwargs.any? || block
+
+      translate(data[Camelise.call(name.to_s)])
+    end
+
+    def respond_to_missing?(name, _include_all)
+      data.key?(Camelise.call(name.to_s))
+    end
+
+    def translate(object)
+      case object
+      when Hash
+        self.class.new(object)
+      when Array
+        object.collect { |item| translate(item) }
+      when String
+        object[TIME_PATTERN] ? Time.parse(object) : object
+      else
+        object
+      end
+    end
+  end
+end

data/lib/render_api/endpoint.rb

@@ -2,6 +2,7 @@
 
 require "http"
 
+require_relative "./camelise"
 require_relative "./response"
 
 module RenderAPI
@@ -17,22 +18,60 @@ module RenderAPI
       request(:get, path, params: params)
     end
 
+    def patch(path, body: nil)
+      request(:patch, path, body: camelise(body))
+    end
+
     def post(path, body: nil)
-      request(:post, path, body: body)
+      request(:post, path, body: camelise(body))
+    end
+
+    def put(path, body: nil)
+      request(:put, path, body: camelise(body))
+    end
+
+    def delete(path)
+      request(:delete, path)
     end
 
     private
 
     attr_reader :api_key
 
+    def camelise(object)
+      case object
+      when Hash
+        object
+          .transform_keys { |key| Camelise.call(key.to_s) }
+          .transform_values { |value| camelise(value) }
+      when Array
+        object.collect { |item| camelise(item) }
+      else
+        object
+      end
+    end
+
+    def handle_error(response)
+      raise RequestError, response.body.to_s
+    end
+
     def http
       HTTP
         .auth("Bearer #{api_key}")
         .headers("Accept" => "application/json")
+        .headers("Content-Type" => "application/json")
     end
 
     def request(verb, path, body: nil, params: nil)
-      Response.new http.request(verb, url_for(path), body: body, params: params)
+      response = http.request(verb, url_for(path), json: body, params: params)
+      handle_error(response) unless response.status.success?
+
+      case response.status.code
+      when 202, 204
+        true
+      else
+        Response.new(response)
+      end
     end
 
     def url_for(path)

data/lib/render_api/response.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "./data_object"
+
 module RenderAPI
   class Response
+    include Enumerable
+
     def initialize(http_response)
       @http_response = http_response
     end
@@ -10,10 +14,18 @@ module RenderAPI
       @data ||= http_response.parse(:json)
     end
 
+    def each(&block)
+      data_objects.each(&block)
+    end
+
     def headers
       @headers ||= http_response.headers.to_h
     end
 
+    def length
+      data_objects.length
+    end
+
     def rate_limit
       headers["Ratelimit-Limit"].to_i
     end
@@ -29,5 +41,31 @@ module RenderAPI
     private
 
     attr_reader :http_response
+
+    def data_object(hash)
+      DataObject.new(hash)
+    end
+
+    def data_objects
+      @data_objects ||=
+        case data
+        when Array
+          data.collect { |hash| data_object(hash) }
+        else
+          [data_object(data)]
+        end
+    end
+
+    def method_missing(name, *args, **kwargs, &block)
+      return super unless respond_to_missing?(name, false)
+
+      data_objects.first.public_send(name, *args, **kwargs, &block)
+    end
+
+    def respond_to_missing?(name, include_all)
+      return false if data.is_a?(Array)
+
+      data_objects.first.respond_to?(name, include_all)
+    end
   end
 end

data/lib/render_api.rb

@@ -4,6 +4,7 @@ require_relative "./render_api/client"
 
 module RenderAPI
   Error = Class.new(StandardError)
+  RequestError = Class.new(Error)
 
   def self.client(api_key)
     RenderAPI::Client.new(api_key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-12 00:00:00.000000000 Z
+date: 2022-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -87,23 +87,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/render_api.rb
+- lib/render_api/camelise.rb
 - lib/render_api/client.rb
 - lib/render_api/clients/base.rb
 - lib/render_api/clients/deploys.rb
+- lib/render_api/clients/domains.rb
+- lib/render_api/clients/jobs.rb
+- lib/render_api/clients/owners.rb
 - lib/render_api/clients/services.rb
+- lib/render_api/data_object.rb
 - lib/render_api/endpoint.rb
 - lib/render_api/response.rb
-- spec/features/deploys_spec.rb
-- spec/features/services_spec.rb
-- spec/spec_helper.rb
-- spec/support/webmock.rb
 homepage: https://github.com/pat/render_api
 licenses:
 - MIT
@@ -127,15 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Ruby interface for the render.com API.
-test_files:
-- spec/features/deploys_spec.rb
-- spec/features/services_spec.rb
-- spec/spec_helper.rb
-- spec/support/webmock.rb
-- ".rspec"
-- Gemfile
-- Rakefile
+test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec

data/Rakefile

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"

data/spec/features/deploys_spec.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "Deploys" do
-  let(:client) { RenderAPI.client "test-api-key" }
-  let(:service_id) { "random-string" }
-
-  subject { client.deploys }
-
-  describe "create" do
-    before :each do
-      stub_request(
-        :post, "https://api.render.com/v1/services/#{service_id}/deploys"
-      ).to_return_json(
-        body: {
-          "id" => "new-deploy",
-          "commit" => {
-            "id" => "string",
-            "message" => "string",
-            "createdAt" => "2021-12-12T08:34:38.327Z"
-          },
-          "status" => "created",
-          "finishedAt" => "2021-12-12T08:34:38.327Z",
-          "createdAt" => "2021-12-12T08:34:38.327Z",
-          "updatedAt" => "2021-12-12T08:34:38.327Z"
-        }
-      )
-    end
-
-    it "returns the new deploy details" do
-      response = subject.create(service_id)
-
-      expect(response.data["id"]).to eq("new-deploy")
-    end
-  end
-
-  describe "list" do
-    before :each do
-      stub_request(
-        :get, "https://api.render.com/v1/services/#{service_id}/deploys"
-      ).to_return_json(
-        body: [
-          {
-            "deploy" => {
-              "id" => "my-deploy",
-              "commit" => {
-                "id" => "string",
-                "message" => "string",
-                "createdAt" => "2021-12-12T08:31:33.669Z"
-              },
-              "status" => "created",
-              "finishedAt" => "2021-12-12T08:31:33.670Z",
-              "createdAt" => "2021-12-12T08:31:33.670Z",
-              "updatedAt" => "2021-12-12T08:31:33.670Z"
-            },
-            "cursor" => "string"
-          }
-        ]
-      )
-    end
-
-    it "returns deploy data" do
-      response = subject.list(service_id)
-
-      expect(response.data.length).to eq(1)
-      expect(response.data.first["deploy"]["id"]).to eq("my-deploy")
-    end
-  end
-end

data/spec/features/services_spec.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "Services" do
-  let(:client) { RenderAPI.client "test-api-key" }
-
-  subject { client.services }
-
-  describe "list" do
-    before :each do
-      stub_request(
-        :get, "https://api.render.com/v1/services"
-      ).to_return_json(
-        body: [
-          {
-            "service" => {
-              "id" => "string",
-              "autoDeploy" => "yes",
-              "branch" => "string",
-              "createdAt" => "2021-12-12T08:02:47.138Z",
-              "name" => "my-service",
-              "notifyOnFail" => "default",
-              "ownerId" => "string",
-              "repo" => "string",
-              "slug" => "string",
-              "suspended" => "suspended",
-              "suspenders" => [
-                "admin"
-              ],
-              "type" => "static_site",
-              "updatedAt" => "2021-12-12T08:02:47.138Z",
-              "serviceDetails" => {
-                "buildCommand" => "string",
-                "parentServer" => {
-                  "id" => "string",
-                  "name" => "string"
-                },
-                "publishPath" => "string",
-                "pullRequestPreviewsEnabled" => "yes",
-                "url" => "string"
-              }
-            },
-            "cursor" => "string"
-          }
-        ]
-      )
-    end
-
-    it "returns service data" do
-      response = subject.list
-
-      expect(response.data.length).to eq(1)
-      expect(response.data.first["service"]["name"]).to eq("my-service")
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "render_api"
-
-require_relative "./support/webmock"
-
-RSpec.configure do |config|
-  config.disable_monkey_patching!
-
-  config.expect_with(:rspec) { |c| c.syntax = :expect }
-end

data/spec/support/webmock.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "delegate"
-require "webmock/rspec"
-
-module WebmockJSONHelpers
-  def stub_request(method, uri)
-    RequestStub.new(super)
-  end
-
-  def a_request(method, uri)
-    RequestPattern.new(super)
-  end
-
-  class RequestStub < SimpleDelegator
-    def to_return_json(*response_hashes, &block)
-      typed_hashes = response_hashes.map do |hash|
-        typed = hash.dup
-
-        typed[:headers] ||= {}
-        typed[:headers]["Content-Type"] = "application/json"
-
-        typed[:body] = JSON.dump(hash[:body] || {})
-
-        typed
-      end
-
-      to_return(*typed_hashes, &block)
-    end
-  end
-
-  class RequestPattern < SimpleDelegator
-    def with_json_body
-      with do |request|
-        yield JSON.parse(request.body)
-      end
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.include WebmockJSONHelpers
-end