red-api 0.1.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34529a5a138b7f837a1e5242eac993f5072eaa897a598d91fc2f4e5d150c11db
-  data.tar.gz: e69e843fd93e86b95f775c9f1d7335f36cd77375e0d79111aa026f09c370c4dc
+  metadata.gz: b953b6b0eb60428808e5e4e96bee115704ccb947e181d1ca00273607ee741a78
+  data.tar.gz: c4658cbf00f844f698f46ab5a3c0e68816d67f82af29971a76914b8337a5d7a7
 SHA512:
-  metadata.gz: 61977f5fef8591ec94c0a88f9064eecf3878442986bbf3cd41626ac11859657d695f37ba7a16b1ef0d384ed14c45f19e1e4ef033213ee508392429e5bb429ebd
-  data.tar.gz: 8ad5a8f28a14e28ff2af2e6496b4542eccefbad7c40f7503ba0af60e3028d14e36b718c60d0e9c46b8cc1d81c877bb4e294a79cb5468b06642b253e86569944d
+  metadata.gz: f075a31f36be34e96985768565d8e3a49c1644c5c3562b5290374d9cf8ec714a3b0d1d1a01db2af96f9cd84dff08307d8eafa615d984b7c1068444face8f6cc8
+  data.tar.gz: 3d6a8aaba3eb5448c479258d45ff3a0c9e9c1dfa136570c7923908c2915a5e8db5e2e25e0d29fa951d108d0837833d16bd051d7eec97df46cd10ca0cf396b222

data/lib/generators/endpoint/USAGE

@@ -1,8 +1,18 @@
 Description:
-    Adds an endpoint api call to your generated API service with optional method params (not to be confused with the api endpoint params)
+    Adds an endpoint api call to your generated API service with optional endpoint method and endpoint helper method parameters
 
+    --include-helper-params:
+      Will copy the --method-params given to your endpoint helper method to use in your endpoint URI path
+      
 Example:
-    rails generate endpoint ServiceName EndpointName /endpoint/#{param1}/#{param2} --method_params param1 param2
+    rails generate endpoint ServiceName version EndpointName /endpoint/#{param1}/#{param2} --method-params param1 param2 --include-helper-params
+    
+    Simple Form:
+      rails generate endpoint ServiceName V1 EndpointName /endpoint
 
     This will create:
-        app/services/ServiceName/api_call/endpoint_name.rb
+        app/services/ServiceName/version/api_call/endpoint_name.rb
+
+    This will modify:
+        app/services/ServiceName/version/api_endpoints.rb
+        app/services/ServiceName/version/endpoint_helpers.rb

data/lib/generators/endpoint/endpoint_generator.rb

@@ -1,46 +1,78 @@
 class EndpointGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
+  argument :api_version, type: :string
   argument :endpoint_name, type: :string
   argument :endpoint, type: :string
-  class_option :method, type: :string, default: :get
-  class_option :method_params, type: :array
 
+  class_option :method, type: :string, default: 'get'
+  class_option :endpoint_params, type: :array
+  class_option :include_helper_params
+  
   def create_api_call
-    @api_name = endpoint_name
+    @api_service = file_name.underscore
+    @api_version = api_version
+    @endpoint_name = endpoint_name
     @endpoint = endpoint
-    @endpoint = @endpoint[1..] if @endpoint.first == '/'
+
+    raise ArgumentError 'Endpoint name required' unless @endpoint_name
+    raise ArgumentError 'Endpoint is required' unless @endpoint
+
+    @endpoint_reference = @api_service.camelize + '::' + @api_version.camelize + '::ApiEndpoints'
+    @full_endpoint_reference = @endpoint_reference + '.' + @endpoint_name.underscore
+
+    @endpoint = @endpoint[1..] unless @endpoint.first != '/'
     @method = options[:method].to_sym
 
-    if options[:method_params].present?
-      @method_params = options[:method_params][0..-2].each_with_object('') do |p, str|
-        str << p << ', '
-      end
-      @method_params << options[:method_params].last
-    end
+    create_endpoint_params if options[:endpoint_params].present?
+    create_helper_params if options[:include_helper_params].present?
 
-    @api_service = file_name.underscore
-    service_dir_path = "app/services/#{@api_service}/"
+    spec_file_name = @endpoint_name.underscore + '_spec.rb';
+    spec_dir = 'spec/services/'
+    spec_api_dir = spec_dir + @api_service.underscore + '/'
+    service_version_dir = spec_api_dir + @api_version.downcase + '/'
 
-    template 'api_call.erb', service_dir_path + "api_calls/#{@api_name.underscore}.rb"
+    Dir.mkdir spec_dir unless File.exist?(spec_dir)
+    Dir.mkdir spec_api_dir unless File.exist?(spec_api_dir)
+    Dir.mkdir service_version_dir unless File.exist?(service_version_dir)
 
-    temp = ERB.new <<-'EOF'
+    spec_file_path = service_version_dir + spec_file_name
 
-  def <%= @api_name.underscore%>_endpoint<%="(#{@method_params})" if @method_params.present?%>
-    <%= "\"#{@endpoint}\".freeze" if @endpoint.present? %>
-  end
-    EOF
+    template 'endpoint_spec.erb', spec_file_path
+
+    service_dir_path = "app/services/#{@api_service}/"
+    service_api_version_path = service_dir_path + @api_version + '/'
+
+    template 'api_call.erb', service_api_version_path + "api_calls/#{@endpoint_name.underscore}.rb"
+
+    api_call_file = ERB.new load_template('endpoint_helper.erb')
     
-    inject_into_file service_dir_path + 'endpoint_helpers.rb', after: "  # API Endpoint Helpers\n" do
-      temp.result(binding)
+    inject_into_file service_api_version_path + 'endpoint_helpers.rb', after: "  # API Endpoint Helpers\n" do
+      api_call_file.result(binding)
+    end
+
+    mixin = ERB.new load_template('mixin.erb')
+
+    inject_into_file service_api_version_path + 'api_endpoints.rb', after: "  # API call modules\n" do
+      mixin.result(binding)
     end
+  end
+
+  private
 
-    temp = ERB.new <<-'EOF'
-  extend <%= @api_name.camelize%>
-    EOF
+  def load_template(template_file)
+    template_path = File.join(File.dirname(__FILE__), 'templates/' + template_file)
+    File.read(template_path)
+  end
+
+  def create_helper_params
+    @helper_params = @endpoint_params
+  end
 
-    inject_into_file service_dir_path + 'api_endpoints.rb', after: "  # API call modules\n" do
-      temp.result(binding)
+  def create_endpoint_params
+    @endpoint_params = options[:endpoint_params][0..-2].each_with_object('') do |p, str|
+      str << p.underscore << ', '
     end
+    @endpoint_params << options[:endpoint_params].last
   end
 end

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

@@ -1,5 +1,5 @@
-module <%= @api_name.camelize%>
-  def <%= @api_name.underscore%><%="(#{@method_params})" if @method_params.present?%>
-    request :<%= @method%>, <%= @api_name.underscore%>_endpoint<%="(#{@method_params})" if @method_params.present?%>, params: {}
+module <%= @endpoint_name.camelize%>
+  def <%= @endpoint_name.underscore%><%="(#{@endpoint_params})" if @endpoint_params%>
+    request :<%= @method%>, <%= @endpoint_name.underscore%>_endpoint<%="(#{@helper_params})" if @helper_params%>, params: {}
   end
 end

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

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

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

@@ -0,0 +1,11 @@
+require 'rails_helper'
+
+RSpec.describe <%=@endpoint_reference%> do
+  describe '<%=@endpoint_name.underscore%>' do
+    it 'returns expected data when successful' do
+      skip 'Write tests for <%=@endpoint_name.underscore%>'
+      <%='# Define endpoint parameters here' if @endpoint_params%>
+      response = <%=@full_endpoint_reference%><%="(#{@endpoint_params})" if @endpoint_params%>
+    end
+  end
+end

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

@@ -0,0 +1 @@
+  extend <%= @endpoint_name.camelize%>

data/lib/generators/service/USAGE

@@ -2,7 +2,14 @@ Description:
     Generates the framework for a basic API service your app consumes
 
 Example:
-    rails generate service ServiceName https://service/api/endpoint/ --key api_key env_key_name
+    rails generate service ServiceName version https://service/api/endpoint/ --key api_key env_key_name
+
+Simple Form:
+    rails generate service ServiceName V1 https://service/api/endpoint/
 
     This will create:
-        app/services/ServiceName
+        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

data/lib/generators/service/service_generator.rb

@@ -1,21 +1,30 @@
 class ServiceGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
+  argument :version, type: :string
   argument :api_endpoint, type: :string
   class_option :key, type: :array
 
   def create_api_service
     @api_name = file_name
+    @api_version = version
     @api_endpoint = api_endpoint
     @env_var_opts = options[:key]
-    raise 'Need to define the name of your API service with --api' unless @api_name.present?
 
-    @api_dir_name = @api_name.underscore
+    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 == '/'
 
     root_dir = "app/services/"
     Dir.mkdir root_dir unless File.exist?(root_dir)
 
-    service_dir_path = "#{root_dir}#{@api_dir_name}/"
+    api_path = root_dir + @api_name.underscore + '/'
+
+    Dir.mkdir api_path unless File.exist?(api_path)
+
+    service_dir_path = api_path + @api_version.downcase + '/'
 
     Dir.mkdir service_dir_path unless File.exist?(service_dir_path)
     Dir.mkdir "#{service_dir_path}/api_calls" unless File.exist?("#{service_dir_path}/api_calls")

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

@@ -1,5 +1,5 @@
-Dir[Rails.root.join('app/services/<%= @api_dir_name%>/api_calls/*.rb')].each { |api_call| require api_call }
+Dir[Rails.root.join('app/services/<%= @api_name.underscore%>/<%=@api_version.downcase%>/api_calls/*.rb')].sort.each { |api_call| require api_call }
 
-class <%= @api_name.camelize%>::ApiEndpoints < <%= @api_name.camelize%>::Client
+class <%=@full_api_reference%>::ApiEndpoints < <%= @full_api_reference%>::Client
   # API call modules
-end
+end

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

@@ -1,6 +1,6 @@
 require_relative 'endpoint_helpers'
 
-class <%= @api_name.camelize%>::Client
+class <%=@full_api_reference%>::Client
   extend EndpointHelpers
 
   def self.client(params)

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Richard DeSilvey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-18 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ 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
@@ -63,6 +77,9 @@ files:
 - lib/generators/endpoint/USAGE
 - lib/generators/endpoint/endpoint_generator.rb
 - lib/generators/endpoint/templates/api_call.erb
+- lib/generators/endpoint/templates/endpoint_helper.erb
+- lib/generators/endpoint/templates/endpoint_spec.erb
+- lib/generators/endpoint/templates/mixin.erb
 - lib/generators/service/USAGE
 - lib/generators/service/service_generator.rb
 - lib/generators/service/templates/api_endpoints.erb