grape-client-generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9968c76ead0846ba188b4706c17afd05809198dc
+  data.tar.gz: c96515b7c46765efc59d1268d052f8a692ecb01d
+SHA512:
+  metadata.gz: 8fcfb671ebbd2cd7182d21483af6b5cefe08d7b74d26287dd46ea8a39941f8b03312c02afe0984df218d612dc3c0c8fbc6a660be4375dc2093122d6d42115b93
+  data.tar.gz: 9871eb364e06eea7d1454c93417bad76efade19ba037f93e256f248be6ee583b98abab9fe12a881fe3385cd7f41d34863d23b5a2416d0743b1bd007c0737b8df

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'grape'
+end
+
+group :test do
+  gem 'rspec', '~> 2.11.0'
+  gem 'rr',    '~> 1.0.4'
+end

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* Birthday!

data/LICENSE

@@ -0,0 +1,177 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,88 @@
+grape-client-generator
+======================
+
+Automatically generate clients for your Grape APIs.
+
+### Installation
+
+Install the gem as you would any other:
+
+```
+gem install grape-client-generator
+```
+
+or put it in your Gemfile.
+
+The grape-client-generator is probably best used in a Rakefile.  Require it like so:
+
+```ruby
+require 'grape/client_generator'
+```
+
+### Usage
+
+Let's say we have a little Grape API that looks like this:
+
+```ruby
+class DummyEndpoints < Grape::API
+
+  desc "I'm a little teapot."
+
+  set(:name, "dummy")
+
+  get :dummy do
+    puts "hello"
+  end
+
+end
+```
+
+**NOTE**: Pay special attention to the call to `set(:name, ...)` above.  grape-client-generator expects all endpoints to give themselves a name that will be used as the method name in the generated class.
+
+grape-client-generator lets you automatically generate a (Ruby) consumer for this API that could potentially be packaged up into a gem.  The `RubyGenerator` class takes in an array of `Grape::API`s to process as well as a number of additional options like `:namespace`, `:class_name`, `:default_version`, and `:response_types`.  Here's an example:
+
+```ruby
+generator = Grape::ClientGenerator::Ruby::RubyGenerator.new([DummyEndpoints], {
+  :namespace => "MyClient",
+  :class_name => "Api",
+  :default_version => "v1",
+  :response_types => [:xml, :json]
+})
+```
+
+To generate the source code for your client, use the `generate_each` method:
+
+```ruby
+generator.generate_each do |file_name, content|
+  File.open(File.join("./output", file_name), "w+") do |f|
+    f.write(content)
+  end
+end
+```
+
+### Disclaimers
+
+This gem makes quite a few assumptions about your Grape endpoints and is far from complete.  For example, it expects each endpoint to have a simple path (i.e. no named arguments) and that you're placing the version in the url (eg. http://mysite.com/v1/...).  Have a feature in mind you'd like to see added?  Submit a pull request!
+
+### Requirements
+
+You'll need to add grape-client-generator into an environment that has access to Grape, although it is not specifically listed as a dependency.
+
+The mustache gem is used to assemble the generated Ruby source files.
+
+If you'd like to use the `JsonResponseParser` that grape-client-generator can generate, you'll need to add one of the json gems into your environment, usually either `json` or `json-pure`.
+
+### Running Tests
+
+Run `bundle exec rake` or `bundle exec rspec`.
+
+### Authors
+
+* Cameron C. Dutro: https://github.com/camertron
+
+## Links
+* grape [https://github.com/intridea/grape](https://github.com/intridea/grape)
+
+## License
+
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

data/Rakefile

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'digest'
+
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/grape/client_generator'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/grape-client-generator.gemspec

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'grape/client-generator/version'
+
+Gem::Specification.new do |s|
+  s.name     = "grape-client-generator"
+  s.version  = ::Grape::ClientGenerator::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["cdutro@twitter.com"]
+  s.homepage = ""
+
+  s.description = s.summary = "Automatically generate clients for your Grape APIs."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'mustache'
+  s.require_path = 'lib'
+
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "LICENSE", "README.md", "Rakefile", "grape-client-generator.gemspec"]
+end

data/lib/grape/client-generator/generator.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+
+module Grape
+  module ClientGenerator
+
+    autoload :Ruby, 'grape/client-generator/ruby'
+
+    class Generator
+
+      DEFAULT_RESPONSE_TYPES = [:xml]
+      DEFAULT_CLASS_NAME = "Api"
+      DEFAULT_VERSION = "v1"
+
+      attr_reader :grape_classes, :response_types, :namespace, :default_version, :class_name
+
+      def initialize(grape_classes, options = {})
+        @grape_classes = grape_classes
+        @response_types = options[:response_types] || DEFAULT_RESPONSE_TYPES
+        @namespace = options[:namespace] || generate_namespace_from(grape_classes.first)
+        @class_name = options[:class_name] || DEFAULT_CLASS_NAME
+        @default_version = options[:default_version] || DEFAULT_VERSION
+      end
+
+      def each_endpoint
+        @grape_classes.each do |grape_class|
+          grape_class.endpoints.each do |endpoint|
+            yield endpoint
+          end
+        end
+      end
+
+      def map_endpoints
+        result = []
+        each_endpoint do |endpoint|
+          result << (yield endpoint)
+        end
+        result
+      end
+
+      protected
+
+      def generate_namespace_from(klass)
+        "#{klass.name.split("::").last}Client"
+      end
+
+    end
+  end
+end

data/lib/grape/client-generator/ruby.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module Grape
+  module ClientGenerator
+    module Ruby
+
+      autoload :ClientFile,         "grape/client-generator/ruby/files"
+      autoload :Api,                "grape/client-generator/ruby/files"
+      autoload :XmlResponseParser,  "grape/client-generator/ruby/files"
+      autoload :JsonResponseParser, "grape/client-generator/ruby/files"
+
+      autoload :RubyGenerator,      "grape/client-generator/ruby/ruby_generator"
+
+    end
+  end
+end

data/lib/grape/client-generator/ruby/files.rb

@@ -0,0 +1,100 @@
+# encoding: UTF-8
+
+require 'mustache'
+
+module Grape
+  module ClientGenerator
+    module Ruby
+
+      class ClientFile
+        attr_reader :generator
+
+        def initialize(generator)
+          @generator = generator
+        end
+
+        def render
+          Mustache.template_path = mustache_path
+          Mustache.render(File.read(input_file), params)
+        end
+
+        def input_file
+          raise NotImplementedError
+        end
+
+        def output_file_name
+          raise NotImplementedError
+        end
+
+        def params
+          raise NotImplementedError
+        end
+
+        protected
+
+        def mustache_file_for(name)
+          File.join(mustache_path, "#{name}.mustache")
+        end
+
+        def mustache_path
+          File.join(File.dirname(__FILE__), "mustache")
+        end
+      end
+
+      class Api < ClientFile
+        def output_file_name
+          "api.rb"
+        end
+
+        def input_file
+          mustache_file_for("api")
+        end
+
+        def params
+          {
+            :namespace => generator.namespace,
+            :class_name => generator.class_name,
+            :default_version => generator.default_version,
+            :default_format => generator.response_types.first,
+            :endpoints => generator.map_endpoints do |endpoint|
+              {
+                :path => endpoint.options[:path].first.to_s,
+                :name => endpoint.settings[:name],  # expected to be set by all endpoints
+                :verb => endpoint.options[:method].first.downcase
+              }
+            end
+          }
+        end
+      end
+
+      class XmlResponseParser < ClientFile
+        def output_file_name
+          "xml_response_parser.rb"
+        end
+
+        def input_file
+          mustache_file_for("xml_response_parser")
+        end
+
+        def params
+          { :namespace => generator.namespace }
+        end
+      end
+
+      class JsonResponseParser < ClientFile
+        def output_file_name
+          "json_response_parser.rb"
+        end
+
+        def input_file
+          mustache_file_for("json_response_parser")
+        end
+
+        def params
+          { :namespace => generator.namespace }
+        end
+      end
+
+    end
+  end
+end

data/lib/grape/client-generator/ruby/mustache/api.mustache

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+
+{{> warning_message}}
+
+require 'net/http'
+require 'cgi'
+
+module {{namespace}}
+  class {{class_name}}
+
+    attr_reader :base_url, :version, :format
+
+    def initialize(base_url, options = {})
+      @base_url = base_url
+      @version = options[:version] || "{{default_version}}"
+      @format = options[:format] || "{{default_format}}"
+    end
+
+  {{#endpoints}}
+    def {{name}}(params = {})
+      make_request("{{verb}}", "{{path}}", params)
+    end
+
+  {{/endpoints}}
+    private
+
+    def make_request(verb, path, params)
+      parse_response(
+        case verb
+          when "post"
+            url = make_post_url(path)
+            post(url, params)
+          when "get"
+            url = make_get_url(path, params)
+            get(url)
+          else
+            raise "Unsupported HTTP verb."
+        end
+      )
+    end
+
+    def parse_response(response)
+      send(:"parse_#{format}_response", response)
+    end
+
+    def parse_xml_response(response)
+      XmlResponseParser.parse(response)
+    end
+
+    def parse_json_response(response)
+      JsonResponseParser.parse(response)
+    end
+
+    def make_param_string(params)
+      (params.map do |key, val|
+        "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}"
+      end).join("&")
+    end
+
+    def make_get_url(path, params)
+      File.join(base_url, version, "#{path}.#{format}", "?#{make_param_string(params)}")
+    end
+
+    def make_post_url(path)
+      File.join(base_url, version, "#{path}.#{format}")
+    end
+
+    def post(url, params)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.path)
+      request.body = make_param_string(params)
+      resp = http.request(request)
+      resp.body
+    end
+
+    def get(url)
+      resp = Net::HTTP.get_response(URI.parse(url))
+      resp.body
+    end
+
+  end
+end

data/lib/grape/client-generator/ruby/mustache/json_response_parser.mustache

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+{{> warning_message}}
+
+# only require this file if you have the json gem available
+require "json"
+
+module {{namespace}}
+  class JsonResponseParser
+
+    class << self
+      def parse(json_text)
+        JSON.parse(json_text)
+      end
+    end
+
+  end
+end

data/lib/grape/client-generator/ruby/mustache/warning_message.mustache

@@ -0,0 +1,3 @@
+# NOTICE:
+# * This file was generated by the grape-client-generator gem.  Changes may be lost on regeneration.
+# * http://github.com/camertron/grape-client-generator

data/lib/grape/client-generator/ruby/mustache/xml_response_parser.mustache

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+
+{{> warning_message}}
+
+require "rexml/document"
+
+module {{namespace}}
+  class XmlResponseParser
+
+    class << self
+      def parse(xml_text)
+        doc = REXML::Document.new(xml_text)
+        name = doc.root.name == "error" ? "error" : "response"
+        { name => parse_element(doc.root) }
+      end
+
+      private
+
+      def parse_element(element)
+        case element
+          when REXML::Element
+            recursive_types = ["hash", "array"]
+            index = recursive_types.index(element.name)
+            index ||= recursive_types.index(element.attributes["type"])
+
+            if index
+              send(:"parse_#{recursive_types[index]}", element)
+            else
+              if element.children.any? { |child| child.is_a?(REXML::Element) }
+                parse_hash(element)
+              else
+                element.text
+              end
+            end
+          when REXML::Text
+            element.value
+        end
+      end
+
+      def parse_hash(element)
+        element.children.inject({}) do |ret, child|
+          if child.is_a?(REXML::Element)
+            key = format_key(child.name)
+            ret[key] = hash_attributes(child.attributes).merge({
+              "value" => parse_element(child)
+            })
+          end
+
+          ret
+        end
+      end
+
+      def hash_attributes(attrs)
+        attrs.inject({}) { |ret, arr| ret[format_key(arr[0])] = arr[1]; ret }
+      end
+
+      def format_key(key)
+        key.gsub("-", "_")
+      end
+
+      def parse_array(element)
+        element.children.map do |child|
+          if child.is_a?(REXML::Element)
+            parse_element(child)
+          end
+        end.compact
+      end
+    end
+
+  end
+end

data/lib/grape/client-generator/ruby/ruby_generator.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+module Grape
+  module ClientGenerator
+    module Ruby
+
+      class RubyGenerator < Generator
+        def generate_each
+          client_file_classes.each do |klass|
+            client_file = klass.new(self)
+            yield client_file.output_file_name, client_file.render
+          end
+        end
+
+        protected
+
+        def client_file_classes
+          list = [Api]
+          list << XmlResponseParser if response_types.include?(:xml)
+          list << JsonResponseParser if response_types.include?(:json)
+          list
+        end
+      end
+
+    end
+  end
+end

data/lib/grape/client-generator/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Grape
+  module ClientGenerator
+    VERSION = "1.0.0"
+  end
+end

data/lib/grape/client_generator.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+
+require 'grape/client-generator/version'
+require 'grape/client-generator/generator'

data/spec/generator_spec.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Grape::ClientGenerator
+
+describe Generator do
+  describe "#initialize" do
+    it "should use sensible defaults" do
+      Generator.new([DummyEndpoints]).tap do |gen|
+        gen.grape_classes.should == [DummyEndpoints]
+        gen.response_types.should == [:xml]
+        gen.namespace.should == "DummyEndpointsClient"
+        gen.class_name.should == "Api"
+        gen.default_version.should == "v1"
+      end
+    end
+
+    it "should allow the defaults to be overridden" do
+      gen = Generator.new([DummyEndpoints], {
+        :response_types => [:json],
+        :namespace => "Blarg",
+        :class_name => "Hello",
+        :default_version => "8"
+      })
+
+      gen.grape_classes.should == [DummyEndpoints]
+      gen.response_types.should == [:json]
+      gen.namespace.should == "Blarg"
+      gen.class_name.should == "Hello"
+      gen.default_version.should == "8"
+    end
+  end
+
+  context "with a generator" do
+    before(:each) do
+      @generator = Generator.new([DummyEndpoints])
+    end
+
+    describe "#each_endpoint" do
+      it "iterates over each endpoint" do
+        endpoints = []
+        @generator.each_endpoint do |endpoint|
+          endpoint.should be_a(Grape::Endpoint)
+          endpoints << endpoint.settings[:name]
+        end
+        endpoints.should == ["kirk", "shaggy"]
+      end
+    end
+
+    describe "#map_endpoints" do
+      it "returns an array of mapped values for the endpoints" do
+        @generator.map_endpoints do |endpoint|
+          endpoint.should be_a(Grape::Endpoint)
+          endpoint.settings[:name]
+        end.should == ["kirk", "shaggy"]
+      end
+    end
+  end
+end

data/spec/ruby/files_spec.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Grape::ClientGenerator
+include Grape::ClientGenerator::Ruby
+
+describe Api do
+  describe "#render" do
+    it "wraps the code in a module and a class with the given names" do
+      generator = Generator.new([DummyEndpoints], {
+        :namespace => "AwesomeClient",
+        :class_name => "GreatApi"
+      })
+
+      Api.new(generator).render.tap do |code|
+        code.should match(/module AwesomeClient/)
+        code.should match(/class GreatApi/)
+      end
+    end
+
+    it "renders a Ruby method for each endpoint with the correct HTTP verb" do
+      generator = Generator.new([DummyEndpoints])
+      Api.new(generator).render.tap do |code|
+        code.should match(/def kirk.*\n\s*make_request\("get"/)
+        code.should match(/def shaggy.*\n\s*make_request\("post"/)
+      end
+    end
+  end
+end
+
+describe XmlResponseParser do
+  describe "#render" do
+    it "wraps the code in the right module namespace" do
+      generator = Generator.new([DummyEndpoints], :namespace => "AwesomeClient")
+      XmlResponseParser.new(generator).render.tap do |code|
+        code.should match(/module AwesomeClient/)
+      end
+    end
+  end
+end
+
+describe JsonResponseParser do
+  describe "#render" do
+    it "wraps the code in the right module namespace" do
+      generator = Generator.new([DummyEndpoints], :namespace => "AwesomeClient")
+      JsonResponseParser.new(generator).render.tap do |code|
+        code.should match(/module AwesomeClient/)
+      end
+    end
+  end
+end

data/spec/ruby/ruby_generator_spec.rb

@@ -0,0 +1,170 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Grape::ClientGenerator::Ruby
+
+describe RubyGenerator do
+  describe "#generate_each" do
+    it "generates the right files" do
+      generator = RubyGenerator.new([DummyEndpoints], {
+        :response_types => [:xml, :json]
+      })
+
+      file_names = []
+      generator.generate_each { |file_name, contents| file_names << file_name }
+      file_names.should == [
+        "api.rb",
+        "xml_response_parser.rb",
+        "json_response_parser.rb"
+      ]
+    end
+  end
+
+  describe "generated classes" do
+    before(:all) do
+      generator = RubyGenerator.new([DummyEndpoints], {
+        :response_types => [:xml, :json],
+        :namespace => "MyClient",
+        :default_format => "xml",
+        :default_version => "v1"
+      })
+
+      @api_module = Module.new do
+        generator.generate_each do |file_name, contents|
+          class_eval(contents)
+        end
+      end
+    end
+
+    it "defines the correct classes" do
+      @api_module.constants.should include(:MyClient)
+
+      [:Api, :XmlResponseParser, :JsonResponseParser].each do |const_sym|
+        @api_module::MyClient.constants.should include(const_sym)
+      end
+    end
+
+    describe "generated api class" do
+      let(:generic_xml_http_response) do
+        Class.new do
+          def body
+            "<some-xml-response></some-xml-response>"
+          end
+        end.new
+      end
+
+      before(:each) do
+        @api = @api_module::MyClient::Api.new("http://twitter.com")
+      end
+
+      it "properly fires off a get request" do
+        expected_uri = URI.parse("http://twitter.com/v1/kirk.xml/?foo=bar&juicy=kale")
+        mock(Net::HTTP).get_response(expected_uri) { generic_xml_http_response }
+
+        @api.kirk(
+          :foo => "bar",
+          :juicy => "kale"
+        )
+      end
+
+      it "properly fires off a post request" do
+        expected_uri = URI.parse("http://twitter.com/v1/shaggy.xml")
+
+        any_instance_of(Net::HTTP) do |http|
+          mock(http).request(anything) do |req|
+            # we have to assume the host is correct since net/http won't give it to us in this context
+            req.path.should == "/v1/shaggy.xml"
+            req.body.should == "foo=bar&juicy=kale"
+
+            generic_xml_http_response
+          end
+        end
+
+        @api.shaggy(
+          :foo => "bar",
+          :juicy => "kale"
+        )
+      end
+    end
+
+    describe "generated json response parser class" do
+      let(:parser) { @api_module::MyClient::JsonResponseParser }
+
+      describe("#parse") do
+        it "parses a json response successfully" do
+          parser.parse('{"hello": "world"}').should == { "hello" => "world" }
+        end
+      end
+    end
+
+    describe "generated xml response parser class" do
+      let(:parser) { @api_module::MyClient::XmlResponseParser }
+
+      describe("#parse") do
+        it "uses 'error' as the root if given an error-ish response" do
+          response = %q(<error><message>jelly beans</message></error>)
+          parser.parse(response).should == {
+            "error" => {
+              "message" => {
+                "value" => "jelly beans"
+              }
+            }
+          }
+        end
+
+        it "handles a single-element hash response" do
+          response = %q(<hash><dumbledore>wizard</dumbledore></hash>)
+          parser.parse(response).should == {
+            "response" => {
+              "dumbledore" => {
+                "value" => "wizard"
+              }
+            }
+          }
+        end
+
+        it "handles an array response" do
+          response = %q(<strings type="array">)
+            response += %q(<string>gryffindor</string><string>hufflepuff</string>)
+            response += %q(<string>ravenclaw</string><string>slytherin</string>)
+          response += %q(</strings>)
+
+          parser.parse(response).should == {
+            "response" => ["gryffindor", "hufflepuff", "ravenclaw", "slytherin"]
+          }
+        end
+
+        it "handles a nested hash and array combination" do
+          response = %q(<hash>) +
+            %q(<houses type="array">) +
+              %q(<house>gryffindor</house>) +
+              %q(<house>hufflepuff</house>) +
+              %q(<house>ravenclaw</house>) +
+              %q(<house>slytherin</house>) +
+            %q(</houses>) +
+            %q(<friends type="array">) +
+              %q(<friend>moony</friend>) +
+              %q(<friend>wormtail</friend>) +
+              %q(<friend>padfoot</friend>) +
+              %q(<friend>prongs</friend>) +
+            %q(</friends>) +
+          %q(</hash>)
+
+          parser.parse(response).should == {
+            "response" => {
+              "houses" => {
+                "type" => "array",
+                "value" => ["gryffindor", "hufflepuff", "ravenclaw", "slytherin"]
+              },
+              "friends" => {
+                "type" => "array",
+                "value" => ["moony", "wormtail", "padfoot", "prongs"]
+              }
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'rspec'
+require 'grape'
+require 'grape/client_generator'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+
+class DummyEndpoints < Grape::API
+
+  desc "I'm a little teapot."
+
+  set(:name, "kirk")
+
+  get :kirk do
+    puts "spock"
+  end
+
+  set(:name, "shaggy")
+
+  post :shaggy do
+    puts "scooby"
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: grape-client-generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustache
+  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'
+description: Automatically generate clients for your Grape APIs.
+email:
+- cdutro@twitter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/grape/client-generator/generator.rb
+- lib/grape/client-generator/ruby/files.rb
+- lib/grape/client-generator/ruby/mustache/api.mustache
+- lib/grape/client-generator/ruby/mustache/json_response_parser.mustache
+- lib/grape/client-generator/ruby/mustache/warning_message.mustache
+- lib/grape/client-generator/ruby/mustache/xml_response_parser.mustache
+- lib/grape/client-generator/ruby/ruby_generator.rb
+- lib/grape/client-generator/ruby.rb
+- lib/grape/client-generator/version.rb
+- lib/grape/client_generator.rb
+- spec/generator_spec.rb
+- spec/ruby/files_spec.rb
+- spec/ruby/ruby_generator_spec.rb
+- spec/spec_helper.rb
+- Gemfile
+- History.txt
+- LICENSE
+- README.md
+- Rakefile
+- grape-client-generator.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Automatically generate clients for your Grape APIs.
+test_files: []