red-api 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3137705ce3933690cf5048fc78576d68a7638499f8a9cdb18c59e83a7010fec
-  data.tar.gz: c01ba2e7a05de477e32e5441677b10f5f488fcd515d81897de746a358fe1fdd4
+  metadata.gz: db9ec72704383f627b78cca8bc5041b932e3c3027a8689f002377527a2a39f80
+  data.tar.gz: 80ad7b3cfef35b8562dbb4a9b4da1de254c48e2e398fd5e224d2931f6937d4bb
 SHA512:
-  metadata.gz: 48f9ed3cfc7b046bd5aab5b642322e42e86120905f474d76651aae224bad5fb1147024d445e23743de6bec8c66fee46b92bc29c33bbe700dfc20e070c7f2d87d
-  data.tar.gz: 74bb4846dab7e79cec7bc43da97f0d64bd4b0013fd18ff29ec328ac6adb657d25f01f1608867c61045694111e741e4b3ef13feaa93ef1e0b886adf318bf84e40
+  metadata.gz: 17f17dbc3020a9ebbf28cdfc7968328a73c3cdfba8b6705e0cf531274cf0c1f5f36b5f0ea0f16655e9b8c5d09481200c7e4a94227b61e1c8c2cffdf741f40d79
+  data.tar.gz: 12f9aec126fe2927daaec3cb5fabec14c884e662616389bb77053106204979c6bb644c35d544419f9d29f6abf49e2143772e3b434ec81441747d6f9771c25952

data/README.md

@@ -7,11 +7,11 @@ This simple gem has two generators to support creating a basic API consumer fram
 
 #### Usage
 ```sh
-rails generate service ApiName https://service/endpoint/ --key api_key service_api_key_env_name
-rails generate endpoint ServiceName EndpointName /endpoint/#{param1}/#{param2} --method_params param1 param2
+rails generate service ApiName Version --endpoint https://service/endpoint/ --key api_key service_api_key_env_name
+rails generate endpoint ServiceName Version EndpointName --endpoint /endpoint/#{param1}/#{param2} --method-params param1 param2 --include-helper-params
 ```
 The service generator will setup the framework which uses Faraday for your http calls and Oj gem for faster json parsing.
-The endpoint generator will setup an endpoint with an endpoint helper method for easier testing.
+The endpoint generator will setup an endpoint with an endpoint helper method for easier testing and adds a spec file.
 
 #### Installation
 ```ruby
@@ -21,6 +21,7 @@ gem 'red-api'
 ```ruby
 gem 'faraday'
 gem 'oj'
+gem 'rspec-rails
 ```
 
 #### Testing

data/lib/generators/endpoint/USAGE

@@ -8,10 +8,11 @@ Example:
     rails generate endpoint ServiceName version EndpointName --endpoint /endpoint/#{param1}/#{param2} --endpoint-params param1 param2 --include-helper-params
     
     Simple Form:
-      rails generate endpoint ServiceName V1 EndpointName /endpoint
+      rails generate endpoint ServiceName V1 EndpointName
 
     This will create:
         app/services/ServiceName/version/api_call/endpoint_name.rb
+        with the endpoint being /v1/ if no endpoint is given
 
     This will modify:
         app/services/ServiceName/version/api_endpoints.rb

data/lib/generators/endpoint/templates/endpoint_helper.erb

@@ -1,4 +1,4 @@
 
   def <%= @endpoint_name.underscore%>_endpoint<%="(#{@helper_params})" if @helper_params%>
-    <%= "\"#{@endpoint}\".freeze" if @endpoint %>
+    <%= "\"#{@endpoint}\"" if @endpoint %>
   end

data/lib/generators/service/USAGE

@@ -2,14 +2,16 @@ Description:
     Generates the framework for a basic API service your app consumes
 
 Example:
-    rails generate service ServiceName version https://service/api/endpoint/ --key api_key env_key_name
+    rails generate service ServiceName version --api-endpoint https://service/api/endpoint/ --key api_key env_key_name
 
 Simple Form:
-    rails generate service ServiceName V1 https://service/api/endpoint/
+    rails generate service ServiceName V1 --api-endpoint https://service/api/endpoint/
+
+    Not supplying an endpoint will default to https://
 
     This will create:
-        app/services/ServiceName/version
-        app/services/ServiceName/version/api_calls/
-        app/services/ServiceName/version/api_endpoints.rb
-        app/services/ServiceName/version/client.rb
-        app/services/ServiceName/version/endpoint_helpers.rb
+        app/services/ServiceName/v1
+        app/services/ServiceName/v1/api_calls/
+        app/services/ServiceName/v1/api_endpoints.rb
+        app/services/ServiceName/v1/client.rb
+        app/services/ServiceName/v1/endpoint_helpers.rb

data/lib/generators/service/templates/client.erb

@@ -6,7 +6,7 @@ class <%=@full_api_reference%>::Client
   def self.client(params)
     <% if @env_var_opts.present? %><%= "params[:#{@env_var_opts.first.underscore.downcase}] = ENV['#{@env_var_opts.last.underscore.upcase}']"%><% else %># Additional params can be added here<% end %>
     Faraday.new(
-      url: api_endpoint,
+      url: <%=@api_name.underscore%>_api_endpoint,
       params: params
     )
   end

data/lib/generators/service/templates/endpoint_helpers.erb

@@ -1,7 +1,7 @@
 module EndpointHelpers
-  def api_endpoint
+  def <%=@api_name.underscore%>_api_endpoint
     # The http API endpoint for this service
-    <%= "'#{@api_endpoint}'.freeze" %>
+    <%= "'#{@api_endpoint}'" %>
   end
 
   # API Endpoint Helpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red-api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.6
 platform: ruby
 authors:
 - Richard DeSilvey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.5
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.1
-- !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'
 description: Generate API service and endpoints for API consumption
 email:
 - rdesilvey@gmail.com