foobara-http-api-command 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eefd62884619d75957db64c7d1516f8295aef58eeb11da24ba666c22b6b8249e
-  data.tar.gz: 9948d0ea1b6703baa80eb2d7f2892214a306ce74cbbfc156eb1e59ccd7ec7c86
+  metadata.gz: 50391d8f44e37644619f61aa1d38eba3104e454d4b652d08561fae9cac5b060b
+  data.tar.gz: ed7174a489766ab28a190967be00f60c3b831636c60515c7f4531ce41909ea04
 SHA512:
-  metadata.gz: 5b8a838148852a0217bf26563af54a22d1b630d1febe0453b8390ffd2dcbd0a93f7bd257a6c41e873acefc81fc7c732329b4b6af0c87ca312c479cd765b809d9
-  data.tar.gz: 0e74fc2f8fd361485438df580f3ffdb62ee2b2f77af2d758ade7dcf0d65a63d043457f3f060bf364bc0b0596f20f699b0eac738cafc99c170732f3ce69805e2d
+  metadata.gz: 36bd3a6473d63328347e23645aa50a87cbc8862c09516acd98eef502c6aaca1a060fec624cbf6cd696318198c0ef75326c6a4b7c649028805fb06ebe39658719
+  data.tar.gz: 7cb9b7b0aecde58a0b4ab81bf26b1670454fffafff66bd61cf61890f106037999fca0a372d3e4ad788b576277a3b814e1c60709b74276ca6478408b876782e85

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.0.4] - 2025-02-17
+
+- Support separate base_url and path helpers
+
+## [0.0.3] - 2025-02-08
+
+- Implement HttpApiPostCommand
+
 ## [0.0.2] - 2025-01-07
 
 - Bump Ruby to 3.4.1

data/src/foobara/concerns/url.rb

@@ -0,0 +1,83 @@
+module Foobara
+  module HttpApiCommand
+    module Concerns
+      module Url
+        include Concern
+
+        def api_url
+          @api_url ||= self.class.compute_api_url(self)
+        end
+
+        module ClassMethods
+          attr_accessor :foobara_base_url_block, :foobara_base_url, :foobara_path, :foobara_url_block, :foobara_url
+
+          def base_url(url = nil, &block)
+            if block_given?
+              unless url.nil?
+                # :nocov:
+                raise ArgumentError, "Cannot specify both url and block"
+                # :nocov:
+              end
+
+              self.foobara_base_url_block = block
+            elsif url
+              self.foobara_base_url = url
+            else
+              # :nocov:
+              raise ArgumentError, "No base url specified"
+              # :nocov:
+            end
+          end
+
+          def path(path = nil)
+            if path
+              self.foobara_path = path
+            end
+          end
+
+          def url(uri = nil, &block)
+            if block_given?
+              unless uri.nil?
+                # :nocov:
+                raise ArgumentError, "Cannot specify both uri and block"
+                # :nocov:
+              end
+
+              self.foobara_url_block = block
+            elsif uri
+              self.foobara_url = uri
+            else
+              # :nocov:
+              raise ArgumentError, "Must give either a url or a block that returns  url"
+              # :nocov:
+            end
+          end
+
+          def compute_api_url(command)
+            if foobara_url
+              foobara_url
+            elsif foobara_url_block
+              command.instance_eval(&foobara_url_block)
+            elsif foobara_path
+              base = if foobara_base_url
+                       foobara_base_url
+                     elsif foobara_base_url_block
+                       command.instance_eval(&foobara_base_url_block)
+                     else
+                       # :nocov:
+                       raise "Not able to determine the api url. Did you remember to call .url or .path and .base_url?"
+                       # :nocov:
+                     end
+
+              "#{base}#{foobara_path}"
+            else
+              # :nocov:
+              raise "Not able to determine the api url. Did you remember to call .url or .path and .base_url?"
+              # :nocov:
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/src/foobara/http_api_command.rb

@@ -0,0 +1,52 @@
+require "uri"
+require "net/http"
+
+module Foobara
+  module HttpApiCommand
+    include Concern
+    include Concerns::Url
+
+    def execute
+      build_request_body
+      build_request_headers
+      issue_http_request
+      parse_response
+      build_result
+    end
+
+    attr_accessor :request_body, :request_headers, :response, :response_body
+
+    def build_request_body
+      self.request_body = {}
+    end
+
+    def build_request_headers
+      self.request_headers = {
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def issue_http_request
+      # :nocov:
+      raise "subclass responsibility"
+      # :nocov:
+    end
+
+    def build_result
+      response_body
+    end
+
+    def parse_response
+      json = if response.is_a?(Net::HTTPSuccess)
+               response.body
+             else
+               # :nocov:
+               raise "Could not successfully hit #{api_url}: " \
+                     "#{response.code} #{response.message}"
+               # :nocov:
+             end
+
+      self.response_body = JSON.parse(json)
+    end
+  end
+end

data/src/foobara/http_api_get_command.rb

@@ -1,67 +1,14 @@
-require "uri"
-require "net/http"
+require_relative "http_api_command"
 
 module Foobara
   module HttpApiGetCommand
     include Concern
-
-    def execute
-      build_request_body
-      build_request_headers
-      issue_http_request
-      parse_response
-      build_result
-    end
-
-    attr_accessor :request_body, :request_headers, :response, :response_body
-
-    def api_url
-      @api_url ||= instance_eval(&self.class.foobara_url_block)
-    end
-
-    def build_request_body
-      self.request_body = {}
-    end
-
-    def build_request_headers
-      self.request_headers = {
-        "Content-Type" => "application/json"
-      }
-    end
+    include HttpApiCommand
 
     def issue_http_request
       uri = URI(api_url)
       uri.query = URI.encode_www_form(request_body)
       self.response = Net::HTTP.get_response(uri, request_headers)
     end
-
-    def build_result
-      response_body
-    end
-
-    def parse_response
-      json = if response.is_a?(Net::HTTPSuccess)
-               response.body
-             else
-               # :nocov:
-               raise "Could not successfully hit #{api_url}: " \
-                     "#{response.code} #{response.message}"
-               # :nocov:
-             end
-
-      self.response_body = JSON.parse(json)
-    end
-
-    module ClassMethods
-      attr_accessor :foobara_url_block
-
-      def url(string = nil, &block)
-        self.foobara_url_block = if block_given?
-                                   block
-                                 else
-                                   proc { string }
-                                 end
-      end
-    end
   end
 end

data/src/foobara/http_api_post_command.rb

@@ -0,0 +1,13 @@
+require_relative "http_api_command"
+
+module Foobara
+  module HttpApiPostCommand
+    include Concern
+    include HttpApiCommand
+
+    def issue_http_request
+      uri = URI.parse(api_url)
+      self.response = Net::HTTP.post(uri, JSON.generate(request_body), request_headers)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara-http-api-command
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
@@ -34,7 +34,10 @@ files:
 - LICENSE.txt
 - README.md
 - lib/foobara/http_api_command.rb
+- src/foobara/concerns/url.rb
+- src/foobara/http_api_command.rb
 - src/foobara/http_api_get_command.rb
+- src/foobara/http_api_post_command.rb
 homepage: https://github.com/foobara/http-api-command
 licenses:
 - MPL-2.0
@@ -57,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: No description. Add one.
 test_files: []