red-api 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34529a5a138b7f837a1e5242eac993f5072eaa897a598d91fc2f4e5d150c11db
+  data.tar.gz: e69e843fd93e86b95f775c9f1d7335f36cd77375e0d79111aa026f09c370c4dc
+SHA512:
+  metadata.gz: 61977f5fef8591ec94c0a88f9064eecf3878442986bbf3cd41626ac11859657d695f37ba7a16b1ef0d384ed14c45f19e1e4ef033213ee508392429e5bb429ebd
+  data.tar.gz: 8ad5a8f28a14e28ff2af2e6496b4542eccefbad7c40f7503ba0af60e3028d14e36b718c60d0e9c46b8cc1d81c877bb4e294a79cb5468b06642b253e86569944d

data/README.md

@@ -0,0 +1,27 @@
+### RED API Generators
+This simple gem has two generators to support creating a basic API consumer framework for your Rails Applications.
+
+#### Generators
+- red-api:service
+- red-api:endpoint
+
+#### 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
+```
+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.
+
+#### Installation
+```ruby
+gem 'red-api'
+```
+#### Dependancies
+```ruby
+gem 'faraday'
+gem 'oj'
+```
+
+#### Testing
+The generator still needs tests and this is my first generator and I'm still learning how to write tests. If you wish to contribute before I get a chance to add tests please PR with tests and I'll review it. Until then the gem won't be published until tests are written.

data/lib/generators/endpoint/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds an endpoint api call to your generated API service with optional method params (not to be confused with the api endpoint params)
+
+Example:
+    rails generate endpoint ServiceName EndpointName /endpoint/#{param1}/#{param2} --method_params param1 param2
+
+    This will create:
+        app/services/ServiceName/api_call/endpoint_name.rb

data/lib/generators/endpoint/endpoint_generator.rb

@@ -0,0 +1,46 @@
+class EndpointGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  argument :endpoint_name, type: :string
+  argument :endpoint, type: :string
+  class_option :method, type: :string, default: :get
+  class_option :method_params, type: :array
+
+  def create_api_call
+    @api_name = endpoint_name
+    @endpoint = endpoint
+    @endpoint = @endpoint[1..] if @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
+
+    @api_service = file_name.underscore
+    service_dir_path = "app/services/#{@api_service}/"
+
+    template 'api_call.erb', service_dir_path + "api_calls/#{@api_name.underscore}.rb"
+
+    temp = ERB.new <<-'EOF'
+
+  def <%= @api_name.underscore%>_endpoint<%="(#{@method_params})" if @method_params.present?%>
+    <%= "\"#{@endpoint}\".freeze" if @endpoint.present? %>
+  end
+    EOF
+    
+    inject_into_file service_dir_path + 'endpoint_helpers.rb', after: "  # API Endpoint Helpers\n" do
+      temp.result(binding)
+    end
+
+    temp = ERB.new <<-'EOF'
+  extend <%= @api_name.camelize%>
+    EOF
+
+    inject_into_file service_dir_path + 'api_endpoints.rb', after: "  # API call modules\n" do
+      temp.result(binding)
+    end
+  end
+end

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

@@ -0,0 +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: {}
+  end
+end

data/lib/generators/service/USAGE

@@ -0,0 +1,8 @@
+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
+
+    This will create:
+        app/services/ServiceName

data/lib/generators/service/service_generator.rb

@@ -0,0 +1,27 @@
+class ServiceGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  argument :api_endpoint, type: :string
+  class_option :key, type: :array
+
+  def create_api_service
+    @api_name = file_name
+    @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
+
+    root_dir = "app/services/"
+    Dir.mkdir root_dir unless File.exist?(root_dir)
+
+    service_dir_path = "#{root_dir}#{@api_dir_name}/"
+
+    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")
+
+    template 'api_endpoints.erb', service_dir_path + 'api_endpoints.rb'
+    template 'client.erb', service_dir_path + 'client.rb'
+    template 'endpoint_helpers.erb', service_dir_path + 'endpoint_helpers.rb'
+  end
+end

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

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

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

@@ -0,0 +1,35 @@
+require_relative 'endpoint_helpers'
+
+class <%= @api_name.camelize%>::Client
+  extend EndpointHelpers
+
+  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,
+      params: params
+    )
+  end
+
+  def self.request(method = :get, endpoint = nil, params: {})
+    raise 'API endpoint must be defined' if endpoint.nil?
+
+    connection = client(params)
+
+    @response = connection.send(method, endpoint)
+
+    return parse_json if response_successful?
+
+    raise "Status: #{@response.status}, Response: #{@response.body}"
+  end
+
+  def self.parse_json
+    Oj.load(@response.body, symbol_keys: true)
+  end
+
+  def self.response_successful?
+    @response.status == 200
+  end
+
+  private_class_method :parse_json, :response_successful?
+end

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

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: red-api
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Richard DeSilvey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: Generate API service and endpoints for API consumption
+email:
+- rdesilvey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/endpoint/USAGE
+- lib/generators/endpoint/endpoint_generator.rb
+- lib/generators/endpoint/templates/api_call.erb
+- lib/generators/service/USAGE
+- lib/generators/service/service_generator.rb
+- lib/generators/service/templates/api_endpoints.erb
+- lib/generators/service/templates/client.erb
+- lib/generators/service/templates/endpoint_helpers.erb
+homepage: https://github.com/redferret/red-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: API service and endpoint generators for Rails
+test_files: []