svelte 0.1.1

data/lib/svelte/path.rb

@@ -0,0 +1,41 @@
+module Svelte
+  # Describes a Swagger API Path
+  class Path
+    attr_reader :non_parameter_elements, :parameter_elements
+
+    # Creates a new Path.
+    # @param path [String] path i.e. `'/store/inventory'`
+    # @param operations [Hash] path operations
+    def initialize(path:, operations:)
+      @path = path
+      separate_path_elements
+      @raw_operations = operations
+    end
+
+    # Path operations
+    # @return [Array<Operation>] list of operations for the path
+    def operations
+      validate_operations
+      @operations ||= @raw_operations.map do |operation, properties|
+        Operation.new(verb: operation, properties: properties, path: self)
+      end
+    end
+
+    private
+
+    def separate_path_elements
+      path_elements = @path.split('/').reject(&:empty?)
+      @non_parameter_elements,
+      @parameter_elements = path_elements.partition do |element|
+        !element.match(/\{\w+\}/)
+      end
+      @parameter_elements.map! { |p| p.scan(/{(\w*)}/) }.flatten!
+    end
+
+    def validate_operations
+      unless @raw_operations.is_a?(Hash)
+        raise JSONError, "Expected the path to contain a list of operations"
+      end
+    end
+  end
+end

data/lib/svelte/path_builder.rb

@@ -0,0 +1,35 @@
+module Svelte
+  # Dynamically builds a module hierarchy on top of a given module
+  # based on the given Path
+  class PathBuilder
+    class << self
+      # Builds a new Module hierarchy on top of `module_constant`
+      # If the path contains more than one part, modules will be built
+      # on top of each other.
+      #
+      # Example:
+      # If the `path` is `/store/inventory` and the `module_constant` is
+      # `Test`, the resulting module hierarchy will be `Test::Store::Inventory`
+      # @param path [Path] path to build
+      # @param module_constant [Module] operation to build
+      def build(path:, module_constant:)
+        create_module_hierarchy(base_module: module_constant,
+                                additional_modules: path.non_parameter_elements)
+      end
+
+      private
+
+      def create_module_hierarchy(base_module:, additional_modules:)
+        additional_modules.reduce(base_module) do |current_module, element|
+          constant_name = StringManipulator.constant_name_for(element)
+
+          unless current_module.const_defined?(constant_name, false)
+            current_module.const_set(constant_name, Module.new)
+          end
+
+          current_module.const_get(constant_name, false)
+        end
+      end
+    end
+  end
+end

data/lib/svelte/rest_client.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+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.)
+      # @param url [String] request url
+      # @param params [Hash] parameters to send to the request
+      # @param options [Hash] options
+      # @raise [HTTPError] if an HTTP layer error occurs,
+      #   an exception will be raised
+      #
+      # @return [Faraday::Response] http response from the service
+      def call(verb:, url:, params: {}, options: {})
+        connection.send verb, url, params do |request|
+          request.options.timeout = options[:timeout] if options[:timeout]
+        end
+      rescue Faraday::TimeoutError => e
+        raise HTTPError.new(parent: e)
+      rescue Faraday::ResourceNotFound => e
+        raise HTTPError.new(parent: e)
+      rescue Faraday::ClientError => e
+        raise HTTPError.new(parent: e)
+      end
+
+      private
+
+      def connection
+        @@connection ||= Faraday.new(ssl: { verify: true }) do |faraday|
+          faraday.request :json
+          faraday.response :json, content_type: /\bjson$/
+          faraday.adapter :typhoeus
+        end
+      end
+    end
+  end
+end

data/lib/svelte/service.rb

@@ -0,0 +1,38 @@
+module Svelte
+  # Dynamically generates a client to consume a Swagger API
+  class Service
+    class << self
+      # Generate a Service via URL or JSON.
+      # @param url [String] full URL of the Swagger API spec
+      # @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
+      # @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
+      #   have `module_name` as its constant name, therefore it can also be
+      #   accessed via `Svelte::Service::<module_name>`. For example, if
+      #   `module_name` is `Comments`, the new module will be built in
+      #   `Svelte::Service::Comments`
+      # @note Either `url` or `json` need to be provided. `url` will take
+      #   precedence over `json`
+      def create(url:, json:, module_name:, options:)
+        json = get_json(url: url) if url
+        SwaggerBuilder.new(raw_hash: JSON.parse(json.to_s),
+                           module_name: module_name,
+                           options: options).make_resource
+      end
+
+      private
+
+      def get_json(url:)
+        Faraday.get(url).body
+      rescue Faraday::ClientError => e
+        raise HTTPError.new(
+          message: "Could not get API json from #{url}",
+          parent: e
+        )
+      end
+    end
+  end
+end

data/lib/svelte/string_manipulator.rb

@@ -0,0 +1,66 @@
+module Svelte
+  # Provides helper methods to manipulate strings in order to generate
+  # valid constant and method names from them
+  module StringManipulator
+    class << self
+      # Generates a valid Ruby constant name as similar as possible to `string`
+      # @param string [String] input string
+      # @return [String] a valid Ruby constant name based on `string`
+      def constant_name_for(string)
+        s = fixify(string)
+        pascalize(s)
+      end
+
+      # Generates a valid Ruby method name as similar as possible to `string`
+      # @param string [String] input string
+      # @return [String] a valid Ruby method name based on `string`
+      def method_name_for(string)
+        s = fixify(string)
+        snakify(s)
+      end
+
+      private
+
+      # Converts a single digit to a number.
+      def fixify(string)
+        dictionary = {
+          '1' => 'One',
+          '2' => 'Two',
+          '3' => 'Three',
+          '4' => 'Four',
+          '5' => 'Five',
+          '6' => 'Six',
+          '7' => 'Seven',
+          '8' => 'Eight',
+          '9' => 'Nine',
+          '0' => 'Zero'
+        }
+
+        string.sub(/^(\d+)/) { dictionary[Regexp.last_match[1]] }
+      end
+
+      def pascalize(string)
+        string.split('-').map(&method(:capitalize_first_char)).join
+      end
+
+      def capitalize_first_char(string)
+        string.sub(/^(.)/) { Regexp.last_match[1].capitalize }
+      end
+
+      def snakify(string)
+        string.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
+          # the start of the string
+          # This is aided by the fact that a acronym cannot be preceded by
+          # an unrelated capital in camel case.
+          gsub(/([A-Z]+)([A-Z])([^A-Z_])/, '\1_\2\3').
+          # This then ensures all lower case letters that
+          # are not yet followed by an underscore
+          # or another lower case letter get an underscored appended.
+          gsub(/([a-z])([^a-z_])/, '\1_\2').downcase
+      end
+    end
+  end
+end

data/lib/svelte/swagger_builder.rb

@@ -0,0 +1,94 @@
+module Svelte
+  # Dynamically builds Swagger API paths and operations on top of a given module
+  class SwaggerBuilder
+    attr_reader :raw_hash, :module_name, :configuration
+
+    # 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:)
+      @raw_hash = raw_hash
+      @module_name = module_name
+      @configuration = build_configuration(options)
+      validate
+    end
+
+    # Dynamically creates a new resource on top of `Svelte::Service` with the
+    # name `module_name`, based on the Swagger API description provided
+    # in `raw_hash`
+    # @return [Module] the module built
+    def make_resource
+      resource = Module.new
+      paths.each do |path|
+        new_module = PathBuilder.build(path: path, module_constant: resource)
+        path.operations.each do |operation|
+          OperationBuilder.build(operation: operation,
+                                 module_constant: new_module,
+                                 configuration: configuration)
+        end
+      end
+      Service.const_set(module_name, resource)
+    end
+
+    # @return [Array<Path>] Paths of the Swagger spec
+    def paths
+      raw_hash['paths'].map do |path, operations|
+        Path.new(path: path, operations: operations)
+      end
+    end
+
+    # @return [String] base path of the Swagger spec
+    def base_path
+      raw_hash['basePath']
+    end
+
+    # @return [String] host of the Swagger spec
+    def host
+      raw_hash['host']
+    end
+
+    private
+
+    def build_configuration(_options)
+      options = {
+          host: host,
+          base_path: base_path,
+          protocol: _options[:protocol]
+      }
+      Configuration.new(options: options)
+    end
+
+    def validate
+      validate_version
+      validate_paths
+      validate_host
+      validate_base_path
+    end
+
+    def validate_version
+      if raw_hash['swagger'] != '2.0'
+        raise VersionError
+      end
+    end
+
+    def validate_paths
+      unless raw_hash['paths'].is_a?(Hash)
+        raise JSONError, 'Expected JSON to contain an object of valid paths'
+      end
+    end
+
+    def validate_host
+      unless raw_hash['host'].is_a?(String)
+        raise JSONError, '`host` field in JSON is invalid'
+      end
+    end
+
+    def validate_base_path
+      unless raw_hash['basePath'].is_a?(String)
+        raise JSONError, '`basePath` field in JSON is invalid'
+      end
+    end
+  end
+end

data/lib/svelte/version.rb

@@ -0,0 +1,4 @@
+module Svelte
+  # Version
+  VERSION = '0.1.1'.freeze
+end

data/svelte.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'svelte/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'svelte'
+  spec.version       = Svelte::VERSION
+  spec.authors       = ['notonthehighstreet.com']
+  spec.email         = ['tech.contact@notonthehighstreet.com']
+
+  spec.summary       = 'Dynamic Ruby API Client from Swagger JSON Spec'
+  spec.description   = 'This gem consumes a Swagger API json file and maps the API into easy-to-use Ruby objects'
+  spec.homepage      = 'https://github.com/notonthehighstreet/svelte'
+  spec.license       = 'MIT'
+
+  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.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 'redcarpet', '~> 3.3'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  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'
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: svelte
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- notonthehighstreet.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.36'
+description: This gem consumes a Swagger API json file and maps the API into easy-to-use
+  Ruby objects
+email:
+- tech.contact@notonthehighstreet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .ruby-version
+- .travis.yml
+- .yardopts
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/svelte.rb
+- lib/svelte/configuration.rb
+- lib/svelte/errors.rb
+- lib/svelte/errors/http_error.rb
+- lib/svelte/errors/json_error.rb
+- lib/svelte/errors/parameter_error.rb
+- lib/svelte/errors/version_error.rb
+- lib/svelte/generic_operation.rb
+- lib/svelte/model_factory.rb
+- lib/svelte/model_factory/parameter.rb
+- lib/svelte/operation.rb
+- lib/svelte/operation_builder.rb
+- lib/svelte/path.rb
+- lib/svelte/path_builder.rb
+- lib/svelte/rest_client.rb
+- lib/svelte/service.rb
+- lib/svelte/string_manipulator.rb
+- lib/svelte/swagger_builder.rb
+- lib/svelte/version.rb
+- svelte.gemspec
+homepage: https://github.com/notonthehighstreet/svelte
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Dynamic Ruby API Client from Swagger JSON Spec
+test_files: []
+has_rdoc: