red-api 0.1.9 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c471a9c123c2bcd52de3e2459f7d282b83172a2c75f54fd4240e9931a80a54
-  data.tar.gz: 3202e5fdff5882c142d9173e593254c09767c67e9aac33765905f4b5eba44274
+  metadata.gz: 8d7d7d53824c734d42780257148211cc70788dc29ac04d03fdaeb427a7eb0467
+  data.tar.gz: 64ef94c872681198c0de4530aa1f9c1c94755c0b80b172e4550db83406990dfe
 SHA512:
-  metadata.gz: 12c9cb3aff98022cc14e545b56dc2388df0ae536bb818b0779dbaa6b6f8de7a8f4260f7ebb61e9dbb6cbab657949988618b3755ff60515f844a543049b3374c9
-  data.tar.gz: 8ca0ef18944bbf57e5ec00c9a05d81a3ca8c5a3ea1ecb5fffdc4602066e4959371953b95a3d31ab30030760965d97164b63f05fbae2f24ade06936707533616e
+  metadata.gz: '08b57006fe0b799f63827c3b52a273ea68ba50633c53559593ecd80e772158013d6920ebdf2aa36e0d07b293a459e126ed32b53a50b6658cd49fc5628f979741'
+  data.tar.gz: fe2faa911327a6744e16d68b1d6dfd75ea1c7f9483a2d77468d58fa79f8e2991a10629a8afbbcd858c80d55bfc6287a293e7445190fe85bd46dc3a011bc5e712

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 /endpoint/#{param1}/#{param2} --endpoint-params param1 param2 --include-helper-params
     
     Simple Form:
       rails generate endpoint ServiceName V1 EndpointName /endpoint

data/lib/generators/endpoint/endpoint_generator.rb

@@ -1,36 +1,38 @@
 class EndpointGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
-  argument :endpoint_name, type: :string
   argument :api_version, type: :string
-  argument :endpoint, type: :string
+  argument :endpoint_name, type: :string
 
-  class_option :method, type: :string, default: :get
+  class_option :endpoint, type: :string, default: '/'
+  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
     @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 == '/'
-    @method = options[:method].to_sym unless options[:method]
+    @endpoint = '/' + @endpoint unless @endpoint.first == '/'
+    @endpoint = @api_version.downcase + @endpoint
+    @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_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,14 +40,7 @@ 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
-    end
+    template 'endpoint_spec.erb', spec_file_path
 
     service_dir_path = "app/services/#{@api_service}/"
     service_api_version_path = service_dir_path + @api_version + '/'
@@ -73,15 +68,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

@@ -1,5 +1,11 @@
 require 'rails_helper'
 
 RSpec.describe <%=@endpoint_reference%> do
-  # API Endpoint tests
-end
+  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

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

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 == '/'
@@ -20,11 +19,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red-api
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.3
 platform: ruby
 authors:
 - Richard DeSilvey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-07-20 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
@@ -79,7 +65,6 @@ files:
 - 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/endpoint_test.erb
 - lib/generators/endpoint/templates/mixin.erb
 - lib/generators/service/USAGE
 - lib/generators/service/service_generator.rb

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

@@ -1,9 +0,0 @@
-
-  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%>
-    end
-  end