swagger-template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65c7eee7824206ced87a66109d5fd06da6e56b78006d30f9d85f9b2acadc9f36
+  data.tar.gz: 4141403d77c254ef8f427535b9ec74fafad758921bd18c7c9a1bd3670b063bb7
+SHA512:
+  metadata.gz: 5ee8afb3951c3562dc2c01ca608cfcfaa118801eefb44e7870072a265d688749544b633f573685a8c547d4e1397dd018866b103d798fd4f3a7ab9d1df4e14114
+  data.tar.gz: ec2a1666a38aa79504b49ec21150116842f174b0dadbbdd64bea633b91b0f253fe032eb489b58c29e12dea2ae851c9aea1d6d8df962cf392c357a3bfdc65441a

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/source
+/output

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "**/*.rb"
+Metrics/LineLength:
+  IgnoredPatterns: ['\A *#']

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0.pre.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cristiano@betta.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in swagger-template.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    swagger-template (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.8.0)
+  bundler (~> 1.16.a)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  swagger-template!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cristiano Betta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Swagger::Template
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swagger/template`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger-template'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger-template
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger-template. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Swagger::Template project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/swagger-template/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "swagger/template/tasks"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc 'Updates the SDK to reflect swagger specs found in ./swagger'
+task :"swagger:template:generate" do
+  Swagger::Template::Tasks.new(
+    swagger_path: './source/swagger',
+    examples: './source/examples.json',
+    templates_path: './templates',
+    output_path: './output',
+    language: 'ruby',
+    root_entity: 'mail_send'
+  ).generate
+end
+
+desc 'Lists the files to be generated based on the Swagger spec'
+task :"swagger:template:list" do
+  Swagger::Template::Tasks.new(
+    swagger_path: './source/swagger',
+    examples: './source/examples.json',
+    templates_path: './templates',
+    output_path: './output',
+    language: 'ruby',
+    root_entity: 'mail_send'
+  ).list
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swagger/template"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/swagger/template/endpoint.rb

@@ -0,0 +1,74 @@
+require "swagger/template/tasks/reader"
+
+module Swagger
+  module Template
+    class Endpoint
+      attr_reader :path, :verb, :summary, :full_path, :classes, :filename,
+                  :parameters, :dirname, :snakecases
+
+      def initialize(spec, path, verb)
+        @spec = spec
+        @path = path
+        @verb = verb
+        extract_summary
+        extract_full_path
+        determine_classes
+        determine_snakecases
+        determine_filename
+        determine_dirname
+        determine_required_parameters
+      end
+
+      def to_h
+        {
+          verb: verb,
+          path: path,
+          summary: summary,
+          full_path: full_path,
+          classes: classes,
+          filename: filename,
+          dirname: dirname,
+          parameters: parameters
+        }
+      end
+
+      private
+
+      def extract_summary
+        @summary = @spec['paths'][path][verb]['summary']
+      end
+
+      def extract_full_path
+        @full_path =  "#{@spec['basePath']}#{path}"
+      end
+
+      def determine_classes
+        @classes = path.split('/').drop(1).map do |chunk|
+          chunk.split('-').map(&:capitalize).join('')
+        end
+      end
+
+      def determine_snakecases
+        @snakecases = path.split('/').drop(1).map do |chunk|
+          chunk.gsub('-', '_')
+        end
+      end
+
+      def determine_filename
+        @filename = path.split('/').drop(1).map do |chunk|
+          chunk.gsub('-', '_')
+        end.join('/')
+      end
+
+      def determine_dirname
+        @dirname = filename.split('/').reverse.drop(1).reverse.join('/')
+      end
+
+      def determine_required_parameters
+        @parameters = @spec['paths'][path][verb]['parameters'].select do |param|
+          param['required']
+        end
+      end
+    end
+  end
+end

data/lib/swagger/template/tasks.rb

@@ -0,0 +1,39 @@
+require "awesome_print"
+require "json"
+require "swagger/template/tasks/reader"
+require "swagger/template/tasks/writer"
+
+module Swagger
+  module Template
+    class Tasks
+      def initialize(options = {})
+        @swagger_path = options[:swagger_path]
+        @templates_path = options[:templates_path]
+        @examples = JSON.parse(File.read(options[:examples]))
+        @output_path = options[:output_path]
+        @language = options[:language]
+        @root_entity = options[:root_entity]
+      end
+
+      def list
+        endpoints = Swagger::Template::Tasks::Reader.new(@swagger_path).read
+        endpoints.each do |endpoint|
+          ap endpoint.to_h
+        end
+      end
+
+      def generate
+        endpoints = Swagger::Template::Tasks::Reader.new(@swagger_path).read
+        Swagger::Template::Tasks::Writer.new(
+            endpoints: endpoints,
+            templates_path: @templates_path,
+            output_path: @output_path,
+            root_entity: @root_entity,
+            root_entity_class: @root_entity.split('_').map(&:capitalize).join,
+            language: @language,
+            examples: @examples
+          ).write
+      end
+    end
+  end
+end

data/lib/swagger/template/tasks/reader.rb

@@ -0,0 +1,42 @@
+require 'json'
+require "swagger/template/endpoint"
+
+module Swagger
+  module Template
+    class Tasks
+      class Reader
+        def initialize(path)
+          @path = path
+        end
+
+        # Reads out the required info from the provided path
+        def read
+          specs = read_swagger_specs(@path)
+          endpoints = extract_endpoints(specs)
+          # enrich_all(endpoints)
+        end
+
+        private
+
+        # Extract every path from the endpoints, generating a list of endpoints
+        # and related data
+        def extract_endpoints(specs)
+          specs.map do |spec|
+            spec['paths'].keys.map do |path|
+              spec['paths'][path].keys.map do |verb|
+                Swagger::Template::Endpoint.new(spec, path, verb)
+              end
+            end
+          end.flatten
+        end
+
+        # Reads the Swagger specs from the path
+        def read_swagger_specs(path)
+          Dir["#{path}/**/*.json"].map do |filename|
+            JSON.parse(File.read(filename))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/template/tasks/template.rb

@@ -0,0 +1,2 @@
+require "swagger/template/version"
+require "swagger/template/tasks"

data/lib/swagger/template/tasks/writer.rb

@@ -0,0 +1,34 @@
+require 'erb'
+require 'fileutils'
+
+module Swagger
+  module Template
+    class Tasks
+      class Writer
+        def initialize(options = {})
+          @endpoints = options[:endpoints]
+          @options = options
+        end
+
+        def write
+          @endpoints.each do |endpoint|
+            render('endpoint', endpoint)
+          end
+        end
+
+        def render(filename, endpoint)
+          @template_filename = "#{@options[:templates_path]}" \
+                               "/#{@options[:language]}/#{filename}.erb"
+          @template = File.read(@template_filename)
+          rendered = ERB.new(@template, nil, '-').result(binding).tap{|ob| puts ob }
+          directory = "#{@options[:output_path]}/#{endpoint.dirname}"
+          filename = "#{@options[:output_path]}/#{endpoint.filename}.rb"
+
+          FileUtils.mkdir_p(directory) unless File.directory?(directory)
+
+          File.open(filename, 'w') { |file| file.write(rendered) }
+        end
+      end
+    end
+  end
+end

data/lib/swagger/template/version.rb

@@ -0,0 +1,5 @@
+module Swagger
+  module Template
+    VERSION = "0.1.0"
+  end
+end

data/swagger-template.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "swagger/template/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagger-template"
+  spec.version       = Swagger::Template::VERSION
+  spec.authors       = ["Cristiano Betta"]
+  spec.email         = ["cristiano@betta.io"]
+
+  spec.summary       = "Generate namespaced clients of template & OpenAPI spec"
+  spec.description   = "Generate namespaced clients of template & OpenAPI spec"
+  spec.homepage      = "https://github.com/workbetta/swagger-template"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "awesome_print", "~> 1.8.0"
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/templates/ruby/endpoint.erb

@@ -0,0 +1,33 @@
+module <%= @options[:root_entity_class] %>
+  class Client
+    # A namespaced client for the
+    # +<%= endpoint.full_path %>+ endpoints
+    #
+    # Access via the +<%= @options[:root_entity_class] %>::Client+ object
+    #
+    #   <%= @options[:root_entity] %> = <%= @options[:root_entity_class] %>::Client.new
+    #   <%= @options[:root_entity] %>.<%= endpoint.snakecases.join('.') %>
+    #
+    class <%= endpoint.classes.join('::') %> < <%= @options[:root_entity_class] %>::Client::Decorator
+      # <%= endpoint.summary %>
+      #
+<% endpoint.parameters.each do |parameter| -%>
+      # @option params [<%= parameter['type'].capitalize %>] :<%= parameter['name'] %>
+<% end -%>
+      #
+      # @return [<%= @options[:root_entity_class] %>::Response] a parsed response
+      # @raise [<%= @options[:root_entity_class] %>::Exceptions::Base] an exception if the call failed
+      #
+      # @example
+      #   <%= @options[:root_entity] %>.<%= endpoint.snakecases.join('.') %>.<%= endpoint.verb %>(
+<% endpoint.parameters.each do |parameter| -%>
+      #     <%= parameter['name'] %>: <%= @options[:examples][parameter['name']].inspect %>,
+<% end -%>
+      #   )
+      #
+      def <%= endpoint.verb %>(params = {})
+        client.<%= endpoint.verb %>('<%= endpoint.full_path %>', params)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: swagger-template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cristiano Betta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Generate namespaced clients of template & OpenAPI spec
+email:
+- cristiano@betta.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swagger/template/endpoint.rb
+- lib/swagger/template/tasks.rb
+- lib/swagger/template/tasks/reader.rb
+- lib/swagger/template/tasks/template.rb
+- lib/swagger/template/tasks/writer.rb
+- lib/swagger/template/version.rb
+- swagger-template.gemspec
+- templates/ruby/endpoint.erb
+homepage: https://github.com/workbetta/swagger-template
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Generate namespaced clients of template & OpenAPI spec
+test_files: []