svelte 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 34985e40ff2a86ef17d228ab1c04e74bde632888
-  data.tar.gz: 0114b3e093c16fcc4c019d5b5916f1ed74974d60
+SHA256:
+  metadata.gz: a8aabcb7e5bafe83a0ad58ec737e2714afc5b2a6cb11264755dda73d2fd23a41
+  data.tar.gz: 96215b0581084eb9d196838ab9ef329030ec6e1cb80103a6b6e9ae0c15627ffd
 SHA512:
-  metadata.gz: 69c540bdc0cdc5ab6b67a116ab5e268595bcaae8f06ad93e3867a8dece5df983b8bb382f90c2772234f033bb15a0960352a58419c518d0cc633d98e2097e7c83
-  data.tar.gz: 1fac84c0b573096562341b87fbfe7eac7a0fef2001d0ca100333b6f444cccd32b3ed11e5b2d8d6663e671138a63bbf6dfb01bcfb98038c5ca906f87794742b63
+  metadata.gz: 2324bc8a06b283b780e6cff3f711609de82c0e1f06e504baaad12cf0200ef2a31ccf05c0027e785f1a00f9b542d5a8dfa2f868385cd6758928463a96eae4aca3
+  data.tar.gz: 92d72d2a0538d3aee9eb6e27826812dc489e0fb6ff3c200a2cb543e817d146a7756d833131c50c2df678ce42505d59c795b897e3e27b89c6269b4e951f9d8af7

data/.gitignore

@@ -10,3 +10,5 @@
 /tmp/
 .tags
 .DS_Store
+vendor/bundle
+tags

data/.rubocop.yml

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

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.6.0

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 rvm:
-  - '2.1'
-  - '2.2'
-  - '2.3.0'
   - '2.4.2'
+  - '2.5.1'
+  - '2.6.0'
 env:
   global:
     - CC_TEST_REPORTER_ID=b82d06c331e2b020fe95a3f884bfb04134156d8c2f740d570eeb550130506e22

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in svelte.gemspec

data/README.md

@@ -6,6 +6,8 @@ It reads a Swagger specification file in JSON, and automatically generates Resou
 
 [![Build Status](https://secure.travis-ci.org/notonthehighstreet/svelte.png?branch=master)](http://travis-ci.org/notonthehighstreet/svelte)
 [![Code Climate](https://codeclimate.com/github/notonthehighstreet/svelte/badges/gpa.svg)](https://codeclimate.com/github/notonthehighstreet/svelte)
+[![Depfu](https://badges.depfu.com/badges/b93998f152cc3865465c6de0d7284248/overview.svg)](https://depfu.com/github/notonthehighstreet/svelte?project_id=6754)
+[![Depfu](https://badges.depfu.com/badges/b93998f152cc3865465c6de0d7284248/count.svg)](https://depfu.com/github/notonthehighstreet/svelte?project_id=6754)
 
 ## Installation
 
@@ -184,7 +186,41 @@ view.valid? # true
 view.as_json # {:currencyCode=>"GBP", :amount=>40.0}
 ```
 
-### Options
+### Service Options
+
+When creating a client from the API spec, you can pass an `options` hash that will determine how the HTTP client interacts with your service.
+
+```ruby
+Svelte::Service.create(
+  url: "http://path/to/swagger/spec/resource.json",
+  module_name: 'PetStore', 
+  options: {
+    host: 'somehost.com',
+    base_path: '/api/v1',
+    protocol: 'https',
+    auth: {
+      basic: {
+        username: "user",
+        password: "pass"
+      }
+    },
+    headers: {
+      runas: 'otheruser'
+    }
+  })
+```
+
+The available options are:
+- `host` : overrides the `host` value found in the Swagger API spec, used when making API requests
+- `base_path` : overrides the `basePath` value found in the Swagger API spec, used when making API requests
+- `protocol` : overrides the network protocol used (default value is "http" when not present)
+- `auth` : sets optional authorization headers.  Possible values:
+  - `{ basic: { username: "value", password: "value" } }` : sets basic authentication credentials
+  - `{ token: "Bearer 12345" }` : sets a generic Authorization header (in this case a Bearer token `12345`)
+- `headers` : a collection of arbitrary key/value pairs converted to HTTP request headers included with each outgoing request
+
+
+### Request Options
 
 You can specify a timeout option on a per request basis. If the request times out a `Svelte::TimeoutError` exception
 will be raised.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'svelte'

data/lib/svelte.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'svelte/version'
 require 'svelte/string_manipulator'
@@ -29,6 +31,13 @@ module Svelte
   # @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
+  # @param options [Hash] configuration options when making HTTP requests
+  #   Supported values are:
+  #     :auth [Hash] either { token: "value" } or { basic: { username: "value", password: "value" }}
+  #     :headers [Hash] HTTP request headers
+  #     :host [String] overrides the "host" value in the Swagger spec
+  #     :base_path [String] overrides the "basePath" value in the Swagger spec
+  #     :protocol [String] overrides the network protocol used (defaults to "http")
   # @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: {})

data/lib/svelte/configuration.rb

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 module Svelte
   # Holds miscelanious configuration options for the current
   # Swagger API specification
   class Configuration
-    attr_reader :host, :base_path, :protocol
+    attr_reader :host, :base_path, :protocol, :headers
     # 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
+      @headers = options[:headers]
     end
 
     private

data/lib/svelte/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'svelte/errors/http_error'
 require 'svelte/errors/json_error'
 require 'svelte/errors/parameter_error'

data/lib/svelte/errors/http_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Svelte error class to represent networking errors
   # It can be customized by passing a specific errror message and
@@ -11,7 +13,7 @@ module Svelte
     # @param parent the parent exception
     def initialize(message: nil, parent: nil)
       @parent = parent
-      super(message || (parent && parent.message))
+      super(message || (parent&.message))
     end
   end
 end

data/lib/svelte/errors/json_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Svelte error class to represent JSON errors
   class JSONError < StandardError; end

data/lib/svelte/errors/parameter_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Svelte error class to represent parameter errors. For example
   # when a request is made and some required parameters are missing

data/lib/svelte/errors/version_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Svelte error class to represent version errors.
   # Raised when a Swagger v1 JSON is fed into Svelte

data/lib/svelte/generic_operation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Class that handles the actual execution of dynamically generated operations
   # Each created operation will eventually call this class in order to make the
@@ -17,10 +19,12 @@ module Svelte
                       parameters: parameters)
         request_parameters = clean_parameters(path: path,
                                               parameters: parameters)
+        request_options = build_request_options(configuration: configuration,
+                                                options: options)
         RestClient.call(verb: verb,
                         url: url,
                         params: request_parameters,
-                        options: options)
+                        options: request_options)
       end
 
       private
@@ -30,9 +34,7 @@ module Svelte
         protocol = configuration.protocol
         host = configuration.host
         base_path = configuration.base_path
-        if base_path == '/'
-          base_path = ''
-        end
+        base_path = '' if base_path == '/'
         "#{protocol}://#{host}#{base_path}#{url_path}"
       end
 
@@ -55,6 +57,14 @@ module Svelte
         end
         clean_parameters
       end
+
+      def build_request_options(configuration:, options:)
+        if configuration.headers&.any?
+          return (options || {}).merge(headers: configuration.headers)
+        end
+
+        options
+      end
     end
   end
 end

data/lib/svelte/model_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'svelte/model_factory/parameter'
 
 module Svelte
@@ -11,6 +13,7 @@ module Svelte
     # @return [Hash] A hash of model names to models created
     def define_models(json)
       return unless json
+
       models = {}
       model_definitions = json['definitions']
       model_definitions.each do |model_name, parameters|
@@ -83,6 +86,7 @@ module Svelte
         required_nested_models = nested_models.keys & required_attributes
         nested_models.each do |nested_model_name, nested_model_info|
           return unless required_nested_models.include?(nested_model_name)
+
           nested_class_name = public_send("#{nested_model_name}=",
                                           nested_model_info['$ref']
                                             .split('/').last)

data/lib/svelte/model_factory/parameter.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Svelte
   module ModelFactory
     # Helper class to wrap around all parameters
     class Parameter
-
       # Constant to represent an unset parameter
       UNSET = Class.new
 
@@ -83,11 +84,13 @@ module Svelte
       def validate_required
         return true unless @required
         return false if unset?
+
         true
       end
 
       def validate_value_in_enum
         return true if @permitted_values.empty?
+
         @permitted_values.include?(value)
       end
 

data/lib/svelte/operation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Describes a Swagger API Operation
   class Operation

data/lib/svelte/operation_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Dynamically builds Swagger API operations on top of a given module
   class OperationBuilder
@@ -15,7 +17,8 @@ module Svelte
             path: operation.path,
             configuration: configuration,
             parameters: builder.request_parameters(full_parameters: parameters),
-            options: builder.options(full_parameters: parameters))
+            options: builder.options(full_parameters: parameters)
+          )
         end
       end
 
@@ -28,6 +31,7 @@ module Svelte
       # @note All keys will be transformed from `Symbol` to `String`
       def request_parameters(full_parameters:)
         return {} if full_parameters.compact.empty?
+
         full_parameters.first.inject({}) do |memo, (k, v)|
           memo.merge!(k.to_s => v)
         end

data/lib/svelte/path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Describes a Swagger API Path
   class Path
@@ -34,7 +36,7 @@ module Svelte
 
     def validate_operations
       unless @raw_operations.is_a?(Hash)
-        raise JSONError, "Expected the path to contain a list of operations"
+        raise JSONError, 'Expected the path to contain a list of operations'
       end
     end
   end

data/lib/svelte/path_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Dynamically builds a module hierarchy on top of a given module
   # based on the given Path

data/lib/svelte/rest_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 require 'typhoeus'
@@ -7,7 +9,6 @@ module Svelte
   # Rest client to make requests to the service endpoints
   class RestClient
     class << self
-
       # Makes an http call to a given REST endpoint
       # @param verb [String] http verb to use for the request
       #   (`get`, `post`, `put`, etc.)
@@ -21,6 +22,7 @@ module Svelte
       def call(verb:, url:, params: {}, options: {})
         connection.send verb, url, params do |request|
           request.options.timeout = options[:timeout] if options[:timeout]
+          options[:headers]&.each { |key, value| request.headers[key] = value }
         end
       rescue Faraday::TimeoutError => e
         raise HTTPError.new(parent: e)

data/lib/svelte/service.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'base64'
+
 module Svelte
   # Dynamically generates a client to consume a Swagger API
   class Service
@@ -7,6 +11,9 @@ module Svelte
       # @param json [String] full Swagger API spec as a String
       # @param module_name [String] constant name where Svelte will
       #   build the functionality on top of
+      # @param options [Hash] options passed as configuration to the
+      #   generated Swagger objects.  :auth options will also be
+      #   used here when making the initial Swagger spec request.
       # @return [Module] A newly created `Module` with the
       #   module hierarchy and methods to consume the Swagger API
       #   The new module will be built on top of `Svelte::Service` and will
@@ -17,22 +24,49 @@ module Svelte
       # @note Either `url` or `json` need to be provided. `url` will take
       #   precedence over `json`
       def create(url: nil, json: nil, module_name:, options: {})
-        json = get_json(url: url) if url
+        headers = build_headers(options: options)
+        json = get_json(url: url, headers: headers) if url
+
         SwaggerBuilder.new(raw_hash: JSON.parse(json.to_s),
                            module_name: module_name,
-                           options: options).make_resource
+                           options: options,
+                           headers: headers).make_resource
       end
 
       private
 
-      def get_json(url:)
-        Faraday.get(url).body
+      def get_json(url:, headers:)
+        connection = Faraday.new(url: url)
+        headers.each { |key, value| connection.headers[key] = value }
+        connection.get.body
       rescue Faraday::ClientError => e
         raise HTTPError.new(
           message: "Could not get API json from #{url}",
           parent: e
         )
       end
+
+      def build_headers(options:)
+        headers = options[:headers].is_a?(Hash) ? options[:headers].clone : {}
+
+        if options[:auth]
+          basic = options[:auth][:basic]
+          token = options[:auth][:token]
+
+          if basic
+            credentials = Base64.encode64([
+              basic[:username],
+              basic[:password]
+            ].join(':')).chomp
+
+            headers['Authorization'] = "Basic #{credentials}"
+          elsif token
+            headers['Authorization'] = token
+          end
+        end
+
+        headers
+      end
     end
   end
 end

data/lib/svelte/string_manipulator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Svelte
   # Provides helper methods to manipulate strings in order to generate
   # valid constant and method names from them
@@ -43,9 +45,7 @@ module Svelte
 
       def pascalize(string)
         string.split('-').map do |dash|
-          dash.split('_').map do |underscore|
-            underscore.split
-          end.flatten
+          dash.split('_').map(&:split).flatten
         end.flatten.map(&method(:capitalize_first_char)).join
       end
 
@@ -54,8 +54,8 @@ module Svelte
       end
 
       def snakify(string)
-        string.gsub(/\s+/, '_').
-        gsub('-', '_').
+        string.gsub(/\s+/, '_')
+              .gsub('-', '_').
           # This first regex handles the case of a string ending in an acroynm
           gsub(/([a-z])([A-Z]+)\z/, '\1_\2').
           # This regex then handles acronyms in other places, including at

data/lib/svelte/swagger_builder.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
+
 module Svelte
   # Dynamically builds Swagger API paths and operations on top of a given module
   class SwaggerBuilder
-    attr_reader :raw_hash, :module_name, :configuration
+    attr_reader :raw_hash, :module_name, :configuration, :headers
 
     # Creates a new SwaggerBuilder
     # @param raw_hash [Hash] Swagger API definition
     # @param module_name [String] name of the constant you want built
     # @param options [Hash] Swagger API options. It will be used to build the
-    #   [Configuration]. Supports the `:host` value for now.
-    def initialize(raw_hash:, module_name:, options:)
+    #   [Configuration]. Supported values: ":host", ":base_path", ":protocol"
+    # @param headers [Hash] REST client HTTP request headers
+    def initialize(raw_hash:, module_name:, options:, headers:)
       @raw_hash = raw_hash
       @module_name = module_name
-      @configuration = build_configuration(options)
+      @configuration = build_configuration(options, headers)
+      @headers = headers
       validate
     end
 
@@ -51,11 +55,12 @@ module Svelte
 
     private
 
-    def build_configuration(_options)
+    def build_configuration(_options, headers)
       options = {
-          host: host,
-          base_path: base_path,
-          protocol: _options[:protocol]
+        host: _options[:host] || host,
+        base_path: _options[:base_path] || base_path,
+        protocol: _options[:protocol],
+        headers: headers || {}
       }
       Configuration.new(options: options)
     end
@@ -68,9 +73,7 @@ module Svelte
     end
 
     def validate_version
-      if raw_hash['swagger'] != '2.0'
-        raise VersionError
-      end
+      raise VersionError if raw_hash['swagger'] != '2.0'
     end
 
     def validate_paths

data/lib/svelte/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Svelte
   # Version
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.2.0'
 end

data/svelte.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'svelte/version'
 
@@ -17,18 +18,18 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = '~> 2.4'
 
   spec.add_dependency 'faraday', '~> 0.9'
   spec.add_dependency 'faraday_middleware', '~> 0.10'
   spec.add_dependency 'typhoeus', '~> 1.0'
 
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
   spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov', '~> 0.11'
-  spec.add_development_dependency 'webmock', '~> 1.22'
-  spec.add_development_dependency 'yard', '~> 0.8'
-  spec.add_development_dependency 'rubocop', '~> 0.36'
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'webmock', '~> 3.6'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svelte
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - notonthehighstreet.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -53,105 +53,105 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.36'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.36'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -217,15 +217,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Dynamic Ruby API Client from Swagger JSON Spec