red-api 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c471a9c123c2bcd52de3e2459f7d282b83172a2c75f54fd4240e9931a80a54
-  data.tar.gz: 3202e5fdff5882c142d9173e593254c09767c67e9aac33765905f4b5eba44274
+  metadata.gz: d3247b741f6c7d6a10fab58ebeeb6ab51c355418b4b791d2c2ffc4f1018e28d4
+  data.tar.gz: e27d1ceb69d5b89b2a4f87cc7ffaf20b5f19f8e3ce3e58cf9abdea2f92de8c50
 SHA512:
-  metadata.gz: 12c9cb3aff98022cc14e545b56dc2388df0ae536bb818b0779dbaa6b6f8de7a8f4260f7ebb61e9dbb6cbab657949988618b3755ff60515f844a543049b3374c9
-  data.tar.gz: 8ca0ef18944bbf57e5ec00c9a05d81a3ca8c5a3ea1ecb5fffdc4602066e4959371953b95a3d31ab30030760965d97164b63f05fbae2f24ade06936707533616e
+  metadata.gz: f8822fc4aaa6ffa7c0f8b824605365b86d65ab68eb1fe93e4144344686717590f1ad98df1f97b674e7c8eb1daf86101945f6bbbe7393d902b6918441668ce20c
+  data.tar.gz: 59201a7157c80514c31bb61fcd9cc52daea985e2924bdc53aaca910b94d542f4ce1c7af9888d61b7f8f32d87870801cf834978888f190ef90e471cc02b23ff1c

data/lib/generators/endpoint/USAGE

@@ -1,8 +1,11 @@
 Description:
     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 version EndpointName /endpoint/#{param1}/#{param2} --method-params param1 param2 --helper-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

data/lib/generators/endpoint/endpoint_generator.rb

@@ -1,13 +1,13 @@
 class EndpointGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
-  argument :endpoint_name, type: :string
   argument :api_version, type: :string
+  argument :endpoint_name, type: :string
   argument :endpoint, type: :string
 
-  class_option :method, type: :string, default: :get
+  class_option :method, type: :string, default: 'get'
   class_option :endpoint_params, type: :array
-  class_option :helper_params, type: :array
+  class_option :include_helper_params
   
   def create_api_call
     @api_service = file_name.underscore
@@ -21,16 +21,16 @@ class EndpointGenerator < Rails::Generators::NamedBase
     @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 unless options[:method]
+    @endpoint = @endpoint[1..] unless @endpoint.first != '/'
+    @method = options[:method].to_sym
 
-    create_endpoint_params unless options[:endpoint_params]
-    create_helper_params unless options[:helper_params]
+    create_endpoint_params if options[:endpoint_params].present?
+    create_helper_params if options[:include_helper_params].present?
 
-    spec_file_name = @endpoint_name.underscore + '_spec.rb';
+    spec_file_name = 'endpoints_spec.rb';
     spec_dir = 'spec/services/'
     spec_api_dir = spec_dir + @api_service.underscore + '/'
-    service_version_dir = spec_api_dir + @api_version + '/'
+    service_version_dir = spec_api_dir + @api_version.downcase + '/'
 
     Dir.mkdir spec_dir unless File.exist?(spec_dir)
     Dir.mkdir spec_api_dir unless File.exist?(spec_api_dir)
@@ -38,13 +38,11 @@ class EndpointGenerator < Rails::Generators::NamedBase
 
     spec_file_path = service_version_dir + spec_file_name
 
-    unless File.exist? spec_file_path
-      template 'endpoint_spec.erb', spec_file_path
-    else
-      end_point_test = ERB.new load_template('endpoint_test.erb')
-      inject_into_file spec_file_path, after: "  # API Endpoint tests\n" do
-        end_point_test.result(binding)
-      end
+    template 'endpoint_spec.erb', spec_file_path unless File.exist? spec_file_path
+
+    end_point_test = ERB.new load_template('endpoint_test.erb')
+    inject_into_file spec_file_path, after: "  # API Endpoint tests\n" do
+      end_point_test.result(binding)
     end
 
     service_dir_path = "app/services/#{@api_service}/"
@@ -73,15 +71,12 @@ class EndpointGenerator < Rails::Generators::NamedBase
   end
 
   def create_helper_params
-    @endpoint_params = options[:helper_params][0..-2].each_with_object('') do |p, str|
-      str << p << ', '
-    end
-    @endpoint_params << options[:helper_params].last
+    @helper_params = @endpoint_params
   end
 
   def create_endpoint_params
     @endpoint_params = options[:endpoint_params][0..-2].each_with_object('') do |p, str|
-      str << p << ', '
+      str << p.underscore << ', '
     end
     @endpoint_params << options[:endpoint_params].last
   end

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

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

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

@@ -2,4 +2,4 @@ require 'rails_helper'
 
 RSpec.describe <%=@endpoint_reference%> do
   # API Endpoint tests
-end
+end

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

@@ -2,8 +2,7 @@
   describe '#<%=@endpoint_name.underscore%>' do
     it 'returns expected data' do
       skip 'Write tests for <%=@endpoint_name.underscore%>'
-      
-      <%='# Define endpoint parameters here' unless @endpoint_params%>
-      response = <%=@full_endpoint_reference%><%="(#{@endpoint_params})" unless @endpoint_params%>
+      <%='# 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

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

data/lib/generators/service/service_generator.rb

@@ -20,11 +20,11 @@ class ServiceGenerator < Rails::Generators::NamedBase
     root_dir = "app/services/"
     Dir.mkdir root_dir unless File.exist?(root_dir)
 
-    api_version_path = root_dir + @api_version.downcase + '/'
+    api_path = root_dir + @api_name.underscore + '/'
 
-    Dir.mkdir api_version_path unless File.exist?(api_version_path)
+    Dir.mkdir api_path unless File.exist?(api_path)
 
-    service_dir_path = api_version_path + api_name.underscore + '/'
+    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,4 +1,4 @@
-Dir[Rails.root.join('app/services/<%= @api_dir_name.underscore%>/<%=@api_version.downcase%>/api_calls/*.rb')].sort.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 <%=@full_api_reference%>::ApiEndpoints < <%= @full_api_reference%>::Client
   # API call modules

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: red-api
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard DeSilvey