raml-ruby-client-generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff71be56ff57da051540f86ea0bc1eb8d689f23e
+  data.tar.gz: 2c904cbbd51335f5d184471bdff9438433582c32
+SHA512:
+  metadata.gz: 86a686783c2bfaebb7480922da507a50ea00dd5e271e9b93d9029339973e65f408703e18658a2affbe37e992a290f4604fae399138dcabe4ca31bf72c4d1dd3f
+  data.tar.gz: bc09ae4b06913923d353994d93b17f6d8ffe098b5586d53dabe690d76369a93420bdc685b50efd7b3437a6bc209a113f42ce168dd49250934d07c9b6c2be9a1f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+samples
+example

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in raml-ruby-client-generator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,38 @@
+# Raml Ruby Client Generator
+
+Auto Generate Ruby Client from Raml.
+
+Features:
+
++ support raml 0.8
++ generate out-of-box Ruby Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'raml-ruby-client-generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install raml-ruby-client-generator
+
+## Usage
+
+```ruby
+gen-raml-ruby gen path/to/raml/file.raml --output example
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/raml-ruby-client-generator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "raml_ruby_client/generator"
+
+# 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

data/bin/gen-raml-ruby

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require "bundler/setup"
+require 'raml_ruby_client/generator'
+
+require 'pry'
+
+class RamlRubyGenerator < Thor
+
+  desc "gen [Raml File]", "generate Ruby Client from Raml File"
+  option :output, :type => :string
+  def gen(raml_file)
+    output = options[:output] || '.'
+    RamlRubyClient::Generator.new.generate(raml_file, output)
+  end
+end
+
+RamlRubyGenerator.start(ARGV)
+
+

data/bin/setup

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

data/lib/raml_ruby_client/generator.rb

@@ -0,0 +1,32 @@
+require "raml_ruby_client/generator/version"
+require "raml_ruby_client/generator/template"
+require "raml_ruby_client/generator/parser"
+require "raml_ruby_client/generator/writer"
+require 'raml'
+require 'fileutils'
+
+require 'pry'
+
+module RamlRubyClient
+  class Generator
+    TEMP_DIR = File.expand_path("../../../samples", __FILE__)
+    LIBRARY_FILES = %w{http.rb client.rb configuration.rb}
+
+    def generate(raml_file, output)
+      parser = Parser.new(raml_file)
+      writer = Writer.new(output)
+
+      writer.write_root_file('Gemfile', Template.load('Gemfile').render({}))
+      writer.write_lib_file("#{parser.library_path}.rb", Template.load('class.rb').render(parser: parser))
+      LIBRARY_FILES.each do |template_name|
+        writer.write_lib_file(
+          File.join(parser.library_path, template_name),
+          Template.load(template_name).render(parser: parser)
+        )
+      end
+
+      writer.flush
+    end
+
+  end
+end

data/lib/raml_ruby_client/generator/parser.rb

@@ -0,0 +1,43 @@
+module RamlRubyClient
+  class Parser
+    attr_reader :raml_object
+
+    def initialize(raml_file)
+      @raml_object = Raml.parse_file(raml_file)
+    end
+
+    def base_uri
+      raml_object.base_uri
+    end
+
+    def config_keys
+      ['endpoint']
+    end
+
+    def apis
+      @apis ||= raml_object.resources.map {|key, resource| parse_apis(key, resource) }.flatten
+    end
+
+    def namespace
+      @namespace ||= raml_object.title.gsub(" ", "/")
+    end
+
+    def module_name
+      namespace.camelize.gsub('::', '')
+    end
+
+    def library_path
+      namespace.gsub("/", "_").downcase
+    end
+
+    private
+
+    def parse_apis(key, resource)
+      resource.children.map {|method| build_api(method, key) }
+    end
+
+    def build_api(method, key)
+      OpenStruct.new({ method_name: "#{method.name}#{key.gsub('/', '_')}", verb: method.name, path: key })
+    end
+  end
+end

data/lib/raml_ruby_client/generator/template.rb

@@ -0,0 +1,47 @@
+require 'erb'
+require 'ostruct'
+require 'active_support/inflector'
+
+module RamlRubyClient
+  class Generator
+    TEMPLATE_DIR = File.expand_path("../templates", __FILE__)
+
+    module TemplateHelper
+      def include(partial, context)
+        template = Template.new(sprintf("_%s.tmpl", partial))
+        template.render(context)
+      end
+
+      def indent(str, spaces)
+        pre = ' ' * spaces
+        str = pre + str.split(/\n/).join("\n" + pre) + "\n"
+        return str unless str.strip.empty?
+        nil
+      end
+    end
+
+    class Context < OpenStruct
+      include TemplateHelper
+
+      def to_binding
+        binding
+      end
+    end
+
+    class Template
+      def self.load(template_name)
+        Template.new(sprintf('%s.tmpl', template_name))
+      end
+
+      def initialize(template_name)
+        file = File.join(TEMPLATE_DIR, template_name)
+        @erb = ERB.new(File.read(file), nil, '-')
+      end
+
+      def render(context)
+        ctx = Context.new(context)
+        @erb.result(ctx.to_binding)
+      end
+    end
+  end
+end

data/lib/raml_ruby_client/generator/templates/Gemfile.tmpl

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'httparty'
+gem 'addressable'

data/lib/raml_ruby_client/generator/templates/_method.tmpl

@@ -0,0 +1,3 @@
+def <%= api.method_name %>(query = {}, body = {}, headers = {})
+  http.<%= api.verb.downcase %>("<%= api.path %>", query: query, body: body, headers: headers)
+end

data/lib/raml_ruby_client/generator/templates/class.rb.tmpl

@@ -0,0 +1,15 @@
+require '<%= parser.library_path %>/client'
+require '<%= parser.library_path %>/configuration'
+
+module <%= parser.module_name %>
+  class << self
+    def configure(&block)
+      @configuration = Configuration.new
+      yield @configuration
+    end
+
+    def config
+      @configuration
+    end
+  end
+end

data/lib/raml_ruby_client/generator/templates/client.rb.tmpl

@@ -0,0 +1,26 @@
+require '<%= parser.library_path %>/http'
+
+module <%= parser.module_name %>
+  class Client
+    attr_reader :config
+
+    # Initialize a client
+    #
+    # @example
+    #   <%= parser.module_name %>::Client.new
+    #
+    def initialize(config = <%= parser.module_name %>.config)
+      @config = config
+    end
+
+<% parser.apis.each do |api| -%>
+<%= indent(include('method', api: api), 4) %>
+<% end -%>
+
+    private
+
+    def http
+      @http ||= Http.new(config)
+    end
+  end
+end

data/lib/raml_ruby_client/generator/templates/configuration.rb.tmpl

@@ -0,0 +1,7 @@
+module <%= parser.module_name %>
+  class Configuration
+<% parser.config_keys.each do |key| -%>
+    attr_accessor :<%= key %>
+<% end -%>
+  end
+end

data/lib/raml_ruby_client/generator/templates/http.rb.tmpl

@@ -0,0 +1,49 @@
+require 'httparty'
+require 'addressable/uri'
+
+module <%= parser.module_name %>
+  class Http # nodoc
+    attr_reader :config
+
+    BASE_URL = "<%= parser.base_uri %>".freeze
+
+    def initialize(config)
+      @config = config
+      @endpoint = config.endpoint || BASE_URL
+    end
+
+    def get(path, options = {})
+      request('GET', path, options)
+    end
+
+    def put(path, options = {})
+      request('PUT', path, options)
+    end
+
+    def post(path, options = {})
+      request('POST', path, options)
+    end
+
+    def delete(path, options = {})
+      request('DELETE', path, options)
+    end
+
+    def options(path, options = {})
+      request('OPTIONS', path, options)
+    end
+
+    def head(path, options = {})
+      request('HEAD', path, options)
+    end
+
+    private
+
+    def request(verb, path, options = {})
+      path = @endpoint + path
+      options.merge!(uri_adapter: Addressable::URI)
+
+      HTTParty.__send__(verb.downcase, path, options)
+    end
+
+  end
+end

data/lib/raml_ruby_client/generator/version.rb

@@ -0,0 +1,5 @@
+module RamlRubyClient
+  class Generator
+    VERSION = "0.0.1"
+  end
+end

data/lib/raml_ruby_client/generator/writer.rb

@@ -0,0 +1,40 @@
+module RamlRubyClient
+  class Writer
+    attr_reader :target_dir
+
+    TEMP_DIR = File.expand_path("../../../../samples", __FILE__)
+
+    def initialize(target_dir)
+      @target_dir = target_dir
+      @temp = File.join(TEMP_DIR, Time.now.to_i.to_s)
+    end
+
+    def write_root_file(name, content)
+      write_file(File.join(@temp, name), content)
+    end
+
+    def write_test_file(path, content)
+      write_file(File.join(@temp, 'test', path), content)
+    end
+
+    def write_lib_file(path, content)
+      write_file(File.join(@temp, 'lib', path), content)
+    end
+
+    def flush
+      FileUtils.mkdir_p(@target_dir)
+      FileUtils.mv Dir.glob(File.join(@temp, '*')), @target_dir
+
+      FileUtils.rm_rf(@temp)
+    end
+
+    private
+
+    def write_file(path, content)
+      FileUtils.mkdir_p File.dirname(path)
+
+      File.open(path, 'wb') {|file| file.write content }
+    end
+
+  end
+end

data/raml-ruby-client-generator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'raml_ruby_client/generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "raml-ruby-client-generator"
+  spec.version       = RamlRubyClient::Generator::VERSION
+  spec.authors       = ["Newell Zhu"]
+  spec.email         = ["zlx.star@gmail.com"]
+
+  spec.summary       = %q{Auto generate Ruby Client from Raml.}
+  spec.description   = %q{Auto generate Ruby Client from Raml.}
+  spec.homepage      = "https://github.com/zlx/raml-ruby-client-generator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   += ['gen-raml-ruby']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "raml_ruby"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: raml-ruby-client-generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Newell Zhu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: raml_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: pry-byebug
+  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: Auto generate Ruby Client from Raml.
+email:
+- zlx.star@gmail.com
+executables:
+- gen-raml-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/gen-raml-ruby
+- bin/setup
+- lib/raml_ruby_client/generator.rb
+- lib/raml_ruby_client/generator/parser.rb
+- lib/raml_ruby_client/generator/template.rb
+- lib/raml_ruby_client/generator/templates/Gemfile.tmpl
+- lib/raml_ruby_client/generator/templates/_method.tmpl
+- lib/raml_ruby_client/generator/templates/class.rb.tmpl
+- lib/raml_ruby_client/generator/templates/client.rb.tmpl
+- lib/raml_ruby_client/generator/templates/configuration.rb.tmpl
+- lib/raml_ruby_client/generator/templates/http.rb.tmpl
+- lib/raml_ruby_client/generator/version.rb
+- lib/raml_ruby_client/generator/writer.rb
+- raml-ruby-client-generator.gemspec
+homepage: https://github.com/zlx/raml-ruby-client-generator
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Auto generate Ruby Client from Raml.
+test_files: []