foobara-http-api-command 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61615cf5f9d004cfc8525fd42c7536da93ca8c8fd55413ea56bf0080fa0002b4
-  data.tar.gz: a303d0d85894a7ad1f17476480e73a91fdb5827e01469f025f9574150f6ebeb2
+  metadata.gz: 47344f134791c7562826026ebe261a8e89152295bb9c65fd8bc7d3a3e8bad97f
+  data.tar.gz: 3db4128c29680b07b59c66a76e8a53daccac99fc589d418ad0e0141c28069d97
 SHA512:
-  metadata.gz: 639a44361ec0e66d04a03f850c828be566c6c914fcbce3cd3a268b53d8ddb83ac971376a8079f65d2f40794f6e546f91696fb2377f7a9937a2f129a94a46c358
-  data.tar.gz: 4ad1211996483b99d7f3f4a416d6c05540dac98e98a94a4518a31bb1472256aa95c80f8baecb6cf05b0112f99298f8f973a5e1fe4e1f53c481fe14b72acfdf25
+  metadata.gz: 5ceca930f5086d7fd0a1814de7cc6915bbace3a0d6c85ba57e19f120004901d1ee823da5d8221c11d1d67a6e3bf82702ea959cce60246aef49b86b423a3b4744
+  data.tar.gz: 2ceaa7be546bde7d013c72dda00829c8f06b52267999c2e98024887d7664d81385ece7536cd3f66b04442d123edb3058d68d824ea27adc78a87e91fb62ed4374

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.0.5] - 2025-02-17
+
+- Support separate base_url and path helpers
+- Eliminate concept of separate mixins for different HTTP methods
+
 ## [0.0.3] - 2025-02-08
 
 - Implement HttpApiPostCommand

data/src/foobara/concerns/url.rb

@@ -0,0 +1,96 @@
+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,
+                        :foobara_http_method
+
+          def http_method(method = nil)
+            if method
+              self.foobara_http_method = method
+            else
+              foobara_http_method || :get
+            end
+          end
+
+          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

@@ -4,6 +4,7 @@ require "net/http"
 module Foobara
   module HttpApiCommand
     include Concern
+    include Concerns::Url
 
     def execute
       build_request_body
@@ -15,10 +16,6 @@ module Foobara
 
     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
@@ -30,9 +27,19 @@ module Foobara
     end
 
     def issue_http_request
-      # :nocov:
-      raise "subclass responsibility"
-      # :nocov:
+      case self.class.http_method
+      when :get
+        uri = URI(api_url)
+        uri.query = URI.encode_www_form(request_body)
+        self.response = Net::HTTP.get_response(uri, request_headers)
+      when :post
+        uri = URI.parse(api_url)
+        self.response = Net::HTTP.post(uri, JSON.generate(request_body), request_headers)
+      else
+        # :nocov:
+        raise "Unknown http method #{self.class.http_method}"
+        # :nocov:
+      end
     end
 
     def build_result
@@ -51,17 +58,5 @@ module Foobara
 
       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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara-http-api-command
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-02-08 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
@@ -34,9 +34,8 @@ 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

data/src/foobara/http_api_get_command.rb

@@ -1,14 +0,0 @@
-require_relative "http_api_command"
-
-module Foobara
-  module HttpApiGetCommand
-    include Concern
-    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
-  end
-end

data/src/foobara/http_api_post_command.rb

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