red-api 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b953b6b0eb60428808e5e4e96bee115704ccb947e181d1ca00273607ee741a78
-  data.tar.gz: c4658cbf00f844f698f46ab5a3c0e68816d67f82af29971a76914b8337a5d7a7
+  metadata.gz: 510e97c50edf1d8586ec0d8cd9b54341886b29eec03eef6841f5398ee3402db1
+  data.tar.gz: bf237d7d9fc214551fd6d9d8160718ae026ce695db5bce64a30209d0204ca672
 SHA512:
-  metadata.gz: f075a31f36be34e96985768565d8e3a49c1644c5c3562b5290374d9cf8ec714a3b0d1d1a01db2af96f9cd84dff08307d8eafa615d984b7c1068444face8f6cc8
-  data.tar.gz: 3d6a8aaba3eb5448c479258d45ff3a0c9e9c1dfa136570c7923908c2915a5e8db5e2e25e0d29fa951d108d0837833d16bd051d7eec97df46cd10ca0cf396b222
+  metadata.gz: 644bc8a30789479629ae2de3788853ccd038e99d7a8d972ed9ea93074e0e7824a4bb3a4fb5eb0b1ac31645c947c38d7d591fdf09c17999d9655b6e85d7879402
+  data.tar.gz: eeeb353573a4123c156666dacbe9ff91880c0452ff80e75b041c35d6419dc4b2aae145a948b3069bfff69b8f0ce33d7f7519d85206720772da0568978da79d55

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

@@ -5,13 +5,14 @@ Description:
       Will copy the --method-params given to your endpoint helper method to use in your endpoint URI path
       
 Example:
-    rails generate endpoint ServiceName version EndpointName /endpoint/#{param1}/#{param2} --method-params param1 param2 --include-helper-params
+    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/endpoint_generator.rb

@@ -3,8 +3,8 @@ class EndpointGenerator < Rails::Generators::NamedBase
 
   argument :api_version, type: :string
   argument :endpoint_name, type: :string
-  argument :endpoint, type: :string
 
+  class_option :endpoint, type: :string, default: '/'
   class_option :method, type: :string, default: 'get'
   class_option :endpoint_params, type: :array
   class_option :include_helper_params
@@ -13,15 +13,17 @@ class EndpointGenerator < Rails::Generators::NamedBase
     @api_service = file_name.underscore
     @api_version = api_version
     @endpoint_name = endpoint_name
-    @endpoint = endpoint
+    @endpoint = options[:endpoint]
 
-    raise ArgumentError 'Endpoint name required' unless @endpoint_name
-    raise ArgumentError 'Endpoint is required' unless @endpoint
+    raise ArgumentError, 'Endpoint name required' unless @endpoint_name
+    raise ArgumentError, 'Version is required, e.g. V1' unless @api_version
+    raise ArgumentError, 'Version should not be included in your endpoint, generator will build it for you' if @endpoint.downcase.include?(@api_version.downcase)
 
     @endpoint_reference = @api_service.camelize + '::' + @api_version.camelize + '::ApiEndpoints'
     @full_endpoint_reference = @endpoint_reference + '.' + @endpoint_name.underscore
 
-    @endpoint = @endpoint[1..] unless @endpoint.first != '/'
+    @endpoint = '/' + @endpoint unless @endpoint.first == '/'
+    @endpoint = @api_version.downcase + @endpoint
     @method = options[:method].to_sym
 
     create_endpoint_params if options[:endpoint_params].present?

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 --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 --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/service_generator.rb

@@ -2,17 +2,16 @@ class ServiceGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
   argument :version, type: :string
-  argument :api_endpoint, type: :string
+  class_option :api_endpoint, type: :string, default: 'https://'
   class_option :key, type: :array
 
   def create_api_service
     @api_name = file_name
     @api_version = version
-    @api_endpoint = api_endpoint
+    @api_endpoint = options[:api_endpoint]
     @env_var_opts = options[:key]
 
     raise ArgumentError, 'Need to give the API version' unless @api_version.present?
-    raise ArgumentError, 'Need to give the API endpoint URI e.g. https://api/' unless @api_endpoint.present?
 
     @full_api_reference = @api_name.camelize + '::' + @api_version.upcase
     @api_endpoint = @api_endpoint + '/' unless @api_endpoint.last == '/'

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.1
+  version: 0.2.5
 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