render_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f518a70ad78745e3ef73b6010b68fe7fd9bd49f6bd57b2a2ca0ce7ec63c9e059
+  data.tar.gz: d441fd7e1962cc2727a8bcaa1e2d1040c6a4352c2d2dc818e58919ebb2653a6c
+SHA512:
+  metadata.gz: 432e9f31a2e42d761bcd2b65c7a1cbe3ee4cf5d2ebfd386d0f240dceca7dc9d852f4405b49382ec11990118440370c278034b0f8c3f10cc50d4bace402033a2d
+  data.tar.gz: 2afd4b56be70de6e0819cce4278c8d997392d8e4a148eb9d513308d96c7cc3fbbd67006896ea976b60f09e278b14951477ab9b48344da31a3ae754ede065d6cc

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.0.1] - 2021-12-12
+
+- Initial release
+- Partial support for service, deploy endpoints.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Pat Allan
+
+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/README.md

@@ -0,0 +1,46 @@
+# Render API
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "render_api"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install render_api
+
+## Usage
+
+```ruby
+client = RenderAPI.client(api_key)
+client.services.list(limit: nil, cursor: nil, filters: nil)
+client.deploys.list(service_id, limit: nil, cursor: nil, filters: nil)
+client.deploys.create(service_id, clear_cache: "do_not_clear")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests, and `bundle exec rubocop` to confirm linting and code structure. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pat/render_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pat/render_api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Render API project's codebase and other repository features is expected to follow the [code of conduct](https://github.com/pat/render_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/render_api/client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "./clients/deploys"
+require_relative "./clients/services"
+require_relative "./endpoint"
+
+module RenderAPI
+  class Client
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def deploys
+      @deploys ||= Clients::Deploys.new(endpoint)
+    end
+
+    def services
+      @services ||= Clients::Services.new(endpoint)
+    end
+
+    private
+
+    attr_reader :api_key
+
+    def endpoint
+      @endpoint = Endpoint.new(api_key)
+    end
+  end
+end

data/lib/render_api/clients/base.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RenderAPI
+  module Clients
+    class Base
+      def initialize(endpoint)
+        @endpoint = endpoint
+      end
+
+      private
+
+      attr_reader :endpoint
+
+      def filter_parameter(value)
+        case value
+        when Array
+          value.join(",")
+        else
+          value.to_s
+        end
+      end
+
+      def list_parameters(limit: nil, cursor: nil, filters: nil)
+        parameters = {}
+        filters ||= {}
+
+        parameters[:limit] = limit unless limit.nil?
+        parameters[:cursor] = cursor unless cursor.nil?
+
+        filters.each do |key, value|
+          parameters[key] = filter_parameter(value)
+        end
+
+        parameters
+      end
+    end
+  end
+end

data/lib/render_api/clients/deploys.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+
+module RenderAPI
+  module Clients
+    class Deploys < Base
+      def create(service_id, clear_cache: nil)
+        body = nil
+        body = { clear_cache: clear_cache } unless clear_cache.nil?
+
+        endpoint.post(
+          "/services/#{service_id}/deploys", body: body
+        )
+      end
+
+      def list(service_id, ...)
+        endpoint.get(
+          "/services/#{service_id}/deploys", params: list_parameters(...)
+        )
+      end
+    end
+  end
+end

data/lib/render_api/clients/services.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+
+module RenderAPI
+  module Clients
+    class Services < Base
+      def list(...)
+        endpoint.get("/services", params: list_parameters(...))
+      end
+    end
+  end
+end

data/lib/render_api/endpoint.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "http"
+
+require_relative "./response"
+
+module RenderAPI
+  class Endpoint
+    HOST = "https://api.render.com"
+    VERSION = "/v1"
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def get(path, params: nil)
+      request(:get, path, params: params)
+    end
+
+    def post(path, body: nil)
+      request(:post, path, body: body)
+    end
+
+    private
+
+    attr_reader :api_key
+
+    def http
+      HTTP
+        .auth("Bearer #{api_key}")
+        .headers("Accept" => "application/json")
+    end
+
+    def request(verb, path, body: nil, params: nil)
+      Response.new http.request(verb, url_for(path), body: body, params: params)
+    end
+
+    def url_for(path)
+      "#{HOST}#{VERSION}#{path}"
+    end
+  end
+end

data/lib/render_api/response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RenderAPI
+  class Response
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def data
+      @data ||= http_response.parse(:json)
+    end
+
+    def headers
+      @headers ||= http_response.headers.to_h
+    end
+
+    def rate_limit
+      headers["Ratelimit-Limit"].to_i
+    end
+
+    def rate_limit_remaining
+      headers["Ratelimit-Remaining"].to_i
+    end
+
+    def rate_limit_reset
+      headers["Ratelimit-Reset"].to_i
+    end
+
+    private
+
+    attr_reader :http_response
+  end
+end

data/lib/render_api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "./render_api/client"
+
+module RenderAPI
+  Error = Class.new(StandardError)
+
+  def self.client(api_key)
+    RenderAPI::Client.new(api_key)
+  end
+end

data/spec/features/deploys_spec.rb

@@ -0,0 +1,68 @@
+# 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

@@ -0,0 +1,55 @@
+# 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

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,43 @@
+# 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

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: render_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/render_api.rb
+- lib/render_api/client.rb
+- lib/render_api/clients/base.rb
+- lib/render_api/clients/deploys.rb
+- lib/render_api/clients/services.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
+metadata:
+  homepage_uri: https://github.com/pat/render_api
+  source_code_uri: https://github.com/pat/render_api
+  changelog_uri: https://github.com/pat/render_api/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+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