svelte 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06bce912bdd4e0dcfa6b3eeca2633bd106a15e3b
+  data.tar.gz: c597344e514d2ac1bf1c4572eb0e154cf84d5c35
+SHA512:
+  metadata.gz: a79f95dee772aec6ff511ef4ba14494b13e2e2fab0a0bf051e5f7d7443c4d6936df9385216e6ddb9156aa5afaa6ed03832eda189cb5287ec2821dfd7cc02700e
+  data.tar.gz: b40b5c6d145cef37558b1760e2c367a738f760aba323e70cf32ca57a1a44f81187ce04f60312209c5ca275debf4028707312741d4bd1a04e9136d345e6daedfa

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/Guardfile
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.tags
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.2

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - '2.1'
+  - '2.2'

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Notonthehighstreet Enterprises Ltd
+
+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,229 @@
+# Svelte
+
+Svelte is a Swagger-to-Ruby object mapper.
+
+It reads a Swagger specification file in JSON, and automatically generates Resource Classes with static methods to represent the various HTTP endpoints.
+
+[![Build Status](https://secure.travis-ci.org/savonrb/savon.png?branch=master)](http://travis-ci.org/savonrb/savon)
+[![Code Climate](https://codeclimate.com/github/notonthehighstreet/svelte/badges/gpa.svg)](https://codeclimate.com/github/notonthehighstreet/svelte)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "svelte"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install svelte
+
+## Usage
+
+Point a service at an actual API spec.
+
+You may pass in a URL pointing to a Swagger spec or the JSON directly:
+
+```ruby
+service = Svelte::Service.create(url: "http://path/to/swagger/spec/resource.json", module_name: 'PetStore')
+service = Svelte::Service.create(json: "{ <JSON here> }", module_name: 'PetStore')
+```
+
+This will build a dynamically generated client on top of `Svelte::Service::PetStore`.
+
+The structure of the new module will be based on the API paths and their respective operations.
+Let's look at an example. Using the complete PetStore spec, we can find the following path:
+
+```json
+"/pet/findByStatus": {
+  "get": {
+    "tags": [
+      "pet"
+    ],
+    "summary": "Finds Pets by status",
+    "description": "Multiple status values can be provided with comma separated strings",
+    "operationId": "findPetsByStatus",
+    "produces": [
+      "application/xml",
+      "application/json"
+    ],
+    "parameters": [
+      {
+        "name": "status",
+        "in": "query",
+        "description": "Status values that need to be considered for filter",
+        "required": true,
+        "type": "array",
+        "items": {
+          "type": "string",
+          "enum": [
+            "available",
+            "pending",
+            "sold"
+          ],
+          "default": "available"
+        },
+        "collectionFormat": "multi"
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "successful operation",
+        "schema": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Pet"
+          }
+        }
+      },
+      "400": {
+        "description": "Invalid status value"
+      }
+    },
+    "security": [
+      {
+        "petstore_auth": [
+          "write:pets",
+          "read:pets"
+        ]
+      }
+    ]
+  }
+}
+```
+
+The path contains two parts: `pet` and `findByStatus`. This will generate
+the following hierarchy in the new module:
+
+```ruby
+Svelte::Service::PetStore::Pet::FindByStatus
+```
+
+We can see the path has one `get` operation. A method will be generated in the
+`FindByStatus` module based on the `operationId` Swagger attribute, which will
+have the following signature:
+
+```ruby
+Svelte::Service::PetStore::Pet::FindByStatus.find_pets_by_status(
+  request_payload,
+  request_options = {}
+)
+```
+
+Where `request_payload` is a `Hash` representing the parameters of the operation
+and `request_options`, defaulting to an empty `Hash`, will be a `Hash` of
+options to pass to the request.
+
+In our case, the parameters would look like this:
+
+```ruby
+request_parameters = {
+  status: ['available', 'pending']
+}
+```
+
+### Responses
+
+Svelte will return a [`Faraday::Request`](http://www.rubydoc.info/gems/faraday/0.9.1/Faraday/Response) object as a response to a call.
+
+### Models
+
+Svelte also provides generators for Swagger models. They allow an easy way
+to programmatically create and validate requests.
+They also provide an `as_json` that will generate a valid json body for
+ a given request.
+
+Consider the definitions key of this Swagger model:
+
+```json
+{
+  "definitions": {
+    "MoneyView": {
+      "id": "MoneyView",
+      "description": "",
+      "required": [
+        "amount",
+        "currencyCode"
+      ],
+      "extends": "",
+      "properties": {
+        "amount": {
+          "type": "number",
+          "format": "double",
+          "description": "Decimal amount"
+        },
+        "currencyCode": {
+          "type": "string",
+          "description": "ISO 3 letter currency code"
+        }
+      }
+    }
+  }
+}
+```
+
+In Svelte you can generate the ruby mapper like this:
+
+```ruby
+class MoneyRequest
+  extend Svelte::ModelFactory
+  define_models_from_file(path_to_models_json_file)
+end
+
+view = MoneyRequest::MoneyView.new
+view.valid? # false
+view.validate # {"currencyCode"=>"Invalid parameter: Missing required parameter", "amount"=>"Invalid parameter: Missing required parameter"}
+view.currencyCode = "GBP"
+view.amount = 40.00
+view.valid? # true
+view.as_json # {:currencyCode=>"GBP", :amount=>40.0}
+```
+
+### Options
+
+You can specify a timeout option on a per request basis. If the request times out a `Svelte::TimeoutError` exception
+will be raised.
+
+```ruby
+begin
+  Svelte::Service::PetStore::Pet::FindByStatus.find_pets_by_status(request.as_json, { timeout: 10 })
+rescue Svelte::TimeoutError => e
+  handle_timeout_error(e)
+end
+```
+
+## Limitations
+
+Svelte is still a work in progress gem and it lacks some features that will be
+implemented in the future. Feel free to request or comment on what you'd like
+to see supported. Here is a non exhaustive list of the pitfalls we've identified
+so far:
+
+* Supports `application/json` request and response types only
+* API calls return a raw [Faraday::Response] objects. We'll support returning
+  dynamically generated model responses based on the Swagger spec response
+  schema
+* Request parameter validation is only done for url based parameters.
+    It'd be possible to add validations to all parameters of the request.
+    In fact the `ModelFactory` already provides that functionality, but it
+    requires the client to call `valid?` on the requests to perform the
+    validation. This should happen automatically
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/notonthehighstreet/svelte/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,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: [:spec]
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'svelte'
+
+# 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/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/svelte.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'svelte/version'
+require 'svelte/string_manipulator'
+require 'svelte/configuration'
+require 'svelte/errors'
+require 'svelte/model_factory'
+require 'svelte/rest_client'
+require 'svelte/service'
+require 'svelte/swagger_builder'
+require 'svelte/path'
+require 'svelte/operation'
+require 'svelte/path_builder'
+require 'svelte/operation_builder'
+require 'svelte/generic_operation'
+
+# Svelte is a sleek Ruby API Client generated from a Swagger spec.
+#
+# You can hand it a spec which defines an path like `/api/comments/{id}` that
+# supports a series of operations like `get`, `post`, `delete`, and a module
+# name you want built (i.e. `Comments`), and it will hand you a
+# `Svelte::Service::Comments` object that can be used like so:
+#
+# @example
+#   Svelte::Service::Comments::Api::Comments.get_comment_by_id(id: 10)
+#   Svelte::Service::Comments::Api::Comments.create_comment(contents: 'nice post!')
+#   Svelte::Service::Comments::Api::Comments.delete_comment_by_id(id: 10)
+module Svelte
+  # @param url [String] url pointing to a Swagger spec
+  # @param json [String] the entire Swagger spec as a String
+  # @param module_name [String] constant name where you want Svelte to build
+  #   the new functionality on top of
+  # @note Either `url` or `json` need to be provided. `url` will take
+  #   precedence over `json`
+  def self.create(url: nil, json: nil, module_name:, options: {})
+    Service.create(url: url, json: json, module_name: module_name, options: options)
+  end
+end

data/lib/svelte/configuration.rb

@@ -0,0 +1,20 @@
+module Svelte
+  # Holds miscelanious configuration options for the current
+  # Swagger API specification
+  class Configuration
+    attr_reader :host, :base_path, :protocol
+    # Creates a new Configuration instance
+    # @param options [Hash] configuration options
+    def initialize(options:)
+      @host = options[:host]
+      @base_path = options[:base_path]
+      @protocol = options[:protocol] || default_protocol
+    end
+
+    private
+
+    def default_protocol
+      'http'
+    end
+  end
+end

data/lib/svelte/errors.rb

@@ -0,0 +1,4 @@
+require 'svelte/errors/http_error'
+require 'svelte/errors/json_error'
+require 'svelte/errors/parameter_error'
+require 'svelte/errors/version_error'

data/lib/svelte/errors/http_error.rb

@@ -0,0 +1,17 @@
+module Svelte
+  # Svelte error class to represent networking errors
+  # It can be customized by passing a specific errror message and
+  # a parent exception, which will contain the http driver specific
+  # error that generated it
+  class HTTPError < StandardError
+    attr_reader :parent
+
+    # Creates a new HTTPError with a message and a parent error
+    # @param message [String] exception message
+    # @param parent the parent exception
+    def initialize(message: nil, parent: nil)
+      @parent = parent
+      super(message || (parent && parent.message))
+    end
+  end
+end

data/lib/svelte/errors/json_error.rb

@@ -0,0 +1,4 @@
+module Svelte
+  # Svelte error class to represent JSON errors
+  class JSONError < StandardError; end
+end

data/lib/svelte/errors/parameter_error.rb

@@ -0,0 +1,5 @@
+module Svelte
+  # Svelte error class to represent parameter errors. For example
+  # when a request is made and some required parameters are missing
+  class ParameterError < StandardError; end
+end