Hub API (#2818)

Author: thoughtbot-summer

.sample.env

@@ -11,6 +11,8 @@ GITHUB_ACCESS_TOKEN=github_access_token_for_octokit
 GITHUB_KEY=github_key_for_oauth_application
 GITHUB_SECRET=github_secret_for_oauth_application
 GOOGLE_TAG_MANAGER_KEY=sample_gtm_key
+HUB_API_TOKEN=abcdef1234567890
+HUB_API_URL=https://hub.thoughtbot.com/api
 KISSMETRICS_API_KEY=api_key
 PAYPAL_PASSWORD=password
 PAYPAL_SIGNATURE=signature

config/initializers/hub.rb

@@ -0,0 +1,6 @@
+require Rails.root.join("lib/hub")
+
+Hub.configure do |config|
+  config.url = ENV["HUB_API_URL"]
+  config.token = ENV["HUB_API_TOKEN"]
+end

lib/hub.rb

@@ -0,0 +1,5 @@
+module Hub
+  # https://github.com/thoughtbot/hub/blob/main/doc/api/restful/README.md
+
+  include ActiveSupport::Configurable
+end

lib/hub/opportunities.rb

@@ -0,0 +1,10 @@
+module Hub
+  module Opportunities
+    # @see https://github.com/thoughtbot/hub/blob/main/doc/api/restful/opportunities.md#create
+    # @param attributes [Hash]
+    # @return [Hash]
+    def self.create(attributes = {})
+      Request.new.post("opportunities", opportunity: attributes)
+    end
+  end
+end

lib/hub/request.rb

@@ -0,0 +1,29 @@
+module Hub
+  class Request
+    def post(...)
+      response = connection.post(...)
+
+      unless response.success?
+        raise ActionController::RoutingError, response.reason_phrase
+      end
+
+      response.body
+    end
+
+    private
+
+    def connection
+      Faraday.new(
+        url: Hub.config.url,
+        # https://github.com/thoughtbot/hub/blob/main/doc/api/restful/README.md#all-requests
+        headers: {
+          "Accept" => "application/vnd.hub+json; version=1",
+          "Authorization" => "Token token=#{Hub.config.token}"
+        }
+      ) do |connection|
+        connection.request :json
+        connection.response :json
+      end
+    end
+  end
+end

spec/lib/hub/opportunities_spec.rb

@@ -0,0 +1,17 @@
+require "rails_helper"
+
+describe Hub::Opportunities do
+  describe ".create" do
+    it "makes a POST request to the Hub API with the correct body" do
+      allow(Hub.config).to receive(:url).and_return("https://hub.thoughtbot.com/api")
+      expected_request =
+        stub_request(:post, "https://hub.thoughtbot.com/api/opportunities")
+          .with(body: {opportunity: {email: "example@example.com"}})
+          .to_return_json(body: {"opportunity" => {"id" => 1}})
+
+      described_class.create({email: "example@example.com"})
+
+      expect(expected_request).to have_been_requested
+    end
+  end
+end

spec/lib/hub/request_spec.rb

@@ -0,0 +1,24 @@
+require "rails_helper"
+
+describe Hub::Request do
+  describe "#post" do
+    it "makes a POST request to the Hub API with the correct headers and body" do
+      allow(Hub.config).to receive(:url).and_return("https://hub.thoughtbot.com/api")
+      allow(Hub.config).to receive(:token).and_return("fake_token")
+      expected_request =
+        stub_request(:post, "https://hub.thoughtbot.com/api/books")
+          .with(
+            headers: {
+              "Accept" => "application/vnd.hub+json; version=1",
+              "Authorization" => "Token token=fake_token"
+            },
+            body: {book: {title: "Example Title"}}
+          )
+          .to_return_json(body: {"book" => {"id" => 1}})
+
+      described_class.new.post("books", {book: {title: "Example Title"}})
+
+      expect(expected_request).to have_been_requested
+    end
+  end
+end