red-api 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3247b741f6c7d6a10fab58ebeeb6ab51c355418b4b791d2c2ffc4f1018e28d4
-  data.tar.gz: e27d1ceb69d5b89b2a4f87cc7ffaf20b5f19f8e3ce3e58cf9abdea2f92de8c50
+  metadata.gz: 34b9e346a9f677ad543137b0d60b1fc5d4719bb159b445671195b85751f2876e
+  data.tar.gz: 01d83f096388b122f96359dd9507cc3d0804be3cbe513240444625f1948b9f6a
 SHA512:
-  metadata.gz: f8822fc4aaa6ffa7c0f8b824605365b86d65ab68eb1fe93e4144344686717590f1ad98df1f97b674e7c8eb1daf86101945f6bbbe7393d902b6918441668ce20c
-  data.tar.gz: 59201a7157c80514c31bb61fcd9cc52daea985e2924bdc53aaca910b94d542f4ce1c7af9888d61b7f8f32d87870801cf834978888f190ef90e471cc02b23ff1c
+  metadata.gz: 81805645c940c74a0458597b7d8727dd03c32e5442c4e59858756ac138ff35043d3b90187d44507a9cac8f901b0bcac8807cc74832ec6aa7533cb45258f91702
+  data.tar.gz: 97571792c684c43b80d772ff24e1f18656155a0045bd132a5d44224add2ffd134f41bfce0c7cf3f45389e7efdd248ff1959cecce4169c454195e336b72647710

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,21 +13,23 @@ 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?
     create_helper_params if options[:include_helper_params].present?
 
-    spec_file_name = 'endpoints_spec.rb';
+    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 + '/'
@@ -38,12 +40,7 @@ class EndpointGenerator < Rails::Generators::NamedBase
 
     spec_file_path = service_version_dir + spec_file_name
 
-    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
+    template 'endpoint_spec.erb', spec_file_path
 
     service_dir_path = "app/services/#{@api_service}/"
     service_api_version_path = service_dir_path + @api_version + '/'

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Richard DeSilvey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-07-22 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,8 +0,0 @@
-
-  describe '#<%=@endpoint_name.underscore%>' do
-    it 'returns expected data' 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