stir 0.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be77e01bede5499bb822ebd4ca70cbd8f7317d80
-  data.tar.gz: 4ff43c2adc1c6effb0ea81465ce5b17cd488fd09
+  metadata.gz: a8231f9df55284e7d1025d29384650275a4b8450
+  data.tar.gz: a4b4a8e4839cd61faa57f692f01e757cc78e04f6
 SHA512:
-  metadata.gz: c602acd1d46aec317c85e279bc0d325654111036cb23c3937bc007fb24d8a22cb127cf7a16b8c8803296b36ff86a485811cd591d49f99ce0002d8a15bbbbe60a
-  data.tar.gz: ac6883e003446ebcd5ee5148bc0a0d8f48f4ae49c2bbcc0ecf322a23807c91d97276c2f36cf9218f63a6ab56c803cad51111633cb9fee11dcf540d30c04f449e
+  metadata.gz: e726329cca20c296fc2ec4d810e95ddd76306b43eeef55d60383859ce3a544ec15c6d835002567f6e7ee539c9b37f51eb52fc9aed00cc253a0d54179982f9d38
+  data.tar.gz: 2b349ee5a0e4a7e5722c1db9a8a4b3bd97d32d769122365dc51afbbf96e72f4be90519e775120602565bebdcbd280131fd994578040c1ae1ce5c0de719c18250

data/lib/stir/all.rb

@@ -0,0 +1,2 @@
+require 'stir/rest'
+require 'stir/soap'

data/lib/stir/base/client.rb

@@ -0,0 +1,15 @@
+module Stir
+  module Base
+    class Client
+
+      def self.set_default_options_for(subclass)
+        subclass.class_eval do
+          include Response
+          attr_reader :response
+        end
+        subclass.config = { config_file: subclass.get_config_filepath(subclass.name.demodulize.underscore) }
+      end
+
+    end
+  end
+end

data/lib/stir/base/configuration.rb

@@ -0,0 +1,113 @@
+module Stir
+  module Base
+    module Configuration
+      attr_accessor :service_config, :config
+      class ConfigurationError < StandardError; end
+
+      def self.included(base)
+        base.extend(Default)
+      end
+
+      def initialize
+        config_list.each { |x| self.class.send(:attr_accessor, x) }
+        configure_callbacks!
+        send(:config=, self.class.config)
+        custom_config_initializers
+      end
+
+      def reload_configs!
+        @service_config = load_configs(@config_file)
+        @service_config[:headers] = {} if @service_config[:headers].nil?
+        set_config_variables
+        @service_config
+      end
+
+      def config=(value)
+        value = value.with_indifferent_access
+        @environment = (value.has_key? :environment) ? value[:environment] : Stir.environment
+        @version = (value.has_key? :version) ? value[:version] : Stir.version
+        @config_file = value[:config_file] if value[:config_file]
+        reload_configs!
+      end
+
+      private
+
+      def custom_config_initializers
+      end
+
+      def config_list
+        fail(NotImplementedError, 'You must provide a list of valid configuration options')
+      end
+
+      def configs_to_send
+        @service_config.slice(*config_list)
+      end
+
+      def merge_configs(args_passed_in = nil)
+        args_passed_in.symbolize_keys! if args_passed_in
+        params_to_send = configs_to_send
+        args_passed_in.each { |key, value| params_to_send[key] = value } unless args_passed_in.nil?
+        transform_config_for_httparty(params_to_send, args_passed_in).symbolize_keys
+      end
+
+      def load_configs(filename)
+        raise(ConfigurationError, "#{filename} not found.") unless File.exists?(filename)
+        config =  YAML.load(ERB.new(File.read(filename)).result)
+        verify_configs(config)
+        config[@version][@environment].with_indifferent_access
+      end
+
+      def verify_configs(config)
+        raise(ConfigurationError, "Version: '#{@version}' is not defined for this client in the config file.") unless config.has_key? @version
+        raise(ConfigurationError, "Environment: '#{@environment}' is not defined for Version: '#{@version}' in the config file.") unless config[@version].has_key? @environment
+      end
+
+      def update_configs!(name, value)
+        name = name.to_s.delete('=')
+        @service_config[name] = value
+        instance_variable_set("@#{name}", value)
+        @service_config.reject! { |key| @service_config[key].nil? }
+      end
+
+      def set_config_variables
+        configs_to_send.each { |k, v| instance_variable_set("@#{k}", v) }
+      end
+
+      def callback_methods
+        config_list.inject([]) do |result, element|
+          result.push("#{element}=".to_sym)
+        end
+      end
+
+      def configure_callbacks!
+        callback_methods.each do |name|
+          m = self.class.instance_method(name)
+          self.class.send(:define_method, name) do |*args, &block|
+            update_configs!(name, *args)
+            m.bind(self).(*args, &block)
+          end
+        end
+      end
+
+
+      module ClassMethods
+        attr_accessor :config
+
+        def config_file=(value)
+          self.config = { config_file: value }
+        end
+
+        def get_config_filepath(filename)
+          File.join(Stir.path, 'config', "#{File.basename(filename)}.yml")
+        end
+      end
+
+      module Default
+        def set_default_options(base)
+          base.extend(ClassMethods)
+        end
+      end
+
+    end
+  end
+end

data/lib/stir/base/response.rb

@@ -0,0 +1,17 @@
+module Stir
+  module Base
+    module Response
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def response(response_name, &block)
+          define_method(response_name.to_sym) { |*args| instance_exec(*args, &block) }
+        end
+      end
+
+    end
+  end
+end

data/lib/stir/base.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'active_support/all'
+require 'base/configuration'
+require 'base/response'
+require 'base/client'
+require 'core_ext/string'
+
+# Work around for ruby 2. The include method is not private in ruby 2.1+
+String.send(:include, CoreExt::String)
+
+
+module Stir
+  class PathNotFoundError < StandardError; end
+
+  class << self
+
+    attr_accessor :path, :environment, :version
+
+    def configure
+      yield self
+      load_clients
+    end
+
+    def configuration
+      instance_values.symbolize_keys
+    end
+
+    private
+
+    def load_clients
+      validate_path_to("#{@path}/clients")
+      Dir.glob("#{@path}/clients/**/*.rb") { |file| require file }
+    end
+
+    def validate_path_to(directory)
+      raise(PathNotFoundError, "Invalid path for Stir clients: #{directory}") unless File.directory?(directory)
+    end
+
+  end
+end

data/lib/stir/config/dependencies.yml

@@ -0,0 +1,3 @@
+---
+  rest: https://rubygems.org/gems/httparty
+  soap: https://rubygems.org/gems/savon

data/lib/stir/config.rb

@@ -0,0 +1,5 @@
+require 'yaml'
+
+def dependency_config
+  YAML.load_file(File.expand_path('config/dependencies.yml', __dir__))
+end

data/lib/stir/core_ext/string.rb

@@ -0,0 +1,13 @@
+module CoreExt
+  module String
+    def interpolate(h)
+      return self if h.nil?
+      self.gsub(/%({\w+})/) do |match|
+        return self if match.nil?
+        key = $1.tr('{}', '').to_sym
+        raise KeyError.new("key{#{key}} not found") unless h.has_key?(key)
+        h[key]
+      end
+    end
+  end
+end

data/lib/stir/rest/endpoints.rb

@@ -0,0 +1,52 @@
+module Stir
+  module Endpoints
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def routes(name, *args)
+      endpoints = self.class.send(:endpoints)
+      endpoint = nil
+      endpoints.each {|x| endpoint = x[name.to_sym] if x[name.to_sym]}
+      return nil if endpoint.nil?
+      base_uri + endpoint.interpolate(args.first)
+    end
+
+    private
+    module ClassMethods
+      def get(name, &block)
+        endpoint(name, :get, &block)
+      end
+
+      def put(name, &block)
+        endpoint(name, :put, &block)
+      end
+
+      def post(name, &block)
+        endpoint(name, :post, &block)
+      end
+
+      def head(name, &block)
+        endpoint(name, :head, &block)
+      end
+
+      def delete(name, &block)
+        endpoint(name, :delete, &block)
+      end
+
+      private
+      def endpoint(name, method, &block)
+        send(:define_method, name) do |*args|
+          @response = HTTParty.send(method, URI.escape(yield.interpolate(args.first)), merge_configs(args.flatten.first))
+        end
+        endpoints.push({name => yield.to_s})
+      end
+
+      def endpoints
+        @endpoints ||= []
+      end
+    end
+
+  end
+end

data/lib/stir/rest/rest_client.rb

@@ -0,0 +1,11 @@
+module Stir
+  class RestClient < Stir::Base::Client
+    include Stir::Endpoints
+    include Stir::RestConfiguration
+
+    def self.inherited(subclass)
+      set_default_options_for(subclass)
+    end
+
+  end
+end

data/lib/stir/rest/rest_configuration.rb

@@ -0,0 +1,40 @@
+module Stir
+  module RestConfiguration
+    include Stir::Base::Configuration
+
+    module ClassMethods
+      attr_accessor :debug_output
+
+      def debug_output(stream = $stderr)
+        @debug_output = stream
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      set_default_options(base)
+    end
+
+    private
+
+    def config_list
+      [:body, :http_proxyaddr, :http_proxyport, :http_proxyuser, :http_proxypass, :limit, :query, :timeout,
+       :local_host, :local_port, :base_uri, :basic_auth, :debug_output, :digest_auth, :format, :headers,
+       :maintain_method_across_redirects, :no_follow, :parser, :connection_adapter, :pem, :query_string_normalizer,
+       :ssl_ca_file, :ssl_ca_path, :verify]
+    end
+
+    def transform_config_for_httparty(params, args_passed_in)
+      args_passed_in = {} if args_passed_in.nil?
+      params = params.to_hash
+      params['basic_auth'].symbolize_keys! if params['basic_auth']
+      params['headers'] = headers if headers
+      params['headers'].merge!(args_passed_in[:headers]) if args_passed_in[:headers]
+      params
+    end
+
+    def custom_config_initializers
+      self.debug_output = self.class.instance_variable_get('@debug_output')
+    end
+  end
+end

data/lib/stir/rest.rb

@@ -0,0 +1,12 @@
+require 'stir/config'
+
+begin
+  require 'httparty'
+rescue ::LoadError
+  raise $!, "Please add httparty (#{dependency_config['rest']}) to your Gemfile to do RESTful API testing\n", $!.backtrace
+end
+
+require 'stir/base'
+require 'stir/rest/rest_configuration'
+require 'stir/rest/endpoints'
+require 'stir/rest/rest_client'

data/lib/stir/soap/operations.rb

@@ -0,0 +1,56 @@
+module Stir
+  module Operations
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def define_operations!
+      @operations = operations
+      @operations.each do |op|
+        next if self.methods.include?(op)
+        self.class.send(:define_method, op) do |*args|
+          @response = get_client.call(op, *args)
+        end
+      end
+    end
+
+    def operations
+      get_operations
+    end
+
+    private
+
+    def get_operations
+      operations = operations_available? ? get_client.operations : []
+      operations << self.class.send(:operations)
+      operations.flatten.uniq
+    end
+
+    def operations_available?
+      return true if get_client.operations rescue RuntimeError
+      false
+    end
+
+    def get_client
+      Savon.client(self.service_config.symbolize_keys)
+    end
+
+    module ClassMethods
+      def operation(op_name, op_alias = nil)
+        self.send(:define_method, op_name) { |*args| @response = get_client.call(op_name, *args) }
+        operations.push(op_name)
+        unless op_alias.nil? || op_alias.empty?
+          self.send(:define_method, op_alias) { |*args| send(op_name, *args) }
+          operations.push(op_alias)
+        end
+      end
+
+      private
+      def operations
+        return @operations if @operations
+        @operations = []
+      end
+
+    end
+  end
+end

data/lib/stir/soap/soap_client.rb

@@ -0,0 +1,16 @@
+module Stir
+  class SoapClient < Stir::Base::Client
+    include Stir::Operations
+    include Stir::SoapConfiguration
+
+    def self.inherited(subclass)
+      set_default_options_for(subclass)
+    end
+
+    def initialize
+      super
+      define_operations!
+    end
+
+  end
+end

data/lib/stir/soap/soap_configuration.rb

@@ -0,0 +1,17 @@
+module Stir
+  module SoapConfiguration
+    include Stir::Base::Configuration
+
+    def self.included(base)
+      set_default_options(base)
+    end
+
+    private
+
+    def config_list
+      [:wsdl, :endpoint, :namespace, :proxy, :open_timeout, :read_timeout, :soap_header, :encoding,
+       :basic_auth, :digest_auth, :log, :log_level, :pretty_print_xml, :wsse_auth]
+    end
+
+  end
+end

data/lib/stir/soap/soap_response.rb

@@ -0,0 +1,22 @@
+require 'savon/response'
+
+module Savon
+  class Response
+
+    def code
+      self.http.code.to_i
+    end
+
+    def headers
+      self.http.headers
+    end
+
+    protected
+
+    def method_missing(name, *args, &block)
+      self.body[args.first]
+    end
+
+  end
+end
+

data/lib/stir/soap.rb

@@ -0,0 +1,13 @@
+require 'stir/config'
+
+begin
+  require 'savon'
+rescue ::LoadError
+  raise $!, "Please add savon (#{dependency_config['soap']}) to your Gemfile to do SOAP API testing\n", $!.backtrace
+end
+
+require 'stir/base'
+require 'stir/soap/soap_configuration'
+require 'stir/soap/operations'
+require 'stir/soap/soap_response'
+require 'stir/soap/soap_client'

data/lib/stir/version.rb

@@ -1,3 +1,5 @@
 module Stir
-  VERSION = "0.1.0"
+
+  VERSION = '2.1.1'
+
 end

data/lib/stir.rb

@@ -1,7 +1,2 @@
-require "stir/version"
-
-raise 'This is a placeholder gem.  Coming soon.'
-
-module Stir
-  # Your code goes here...
-end
+$LOAD_PATH << File.dirname(__FILE__)
+raise LoadError.new('You must explictly require "stir/rest", "stir/soap" or "stir/all"')

metadata

@@ -1,81 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: stir
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.1.1
 platform: ruby
 authors:
-- uchagani
+- Umair Chagani
+- Wallace Harwood
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.13.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.13.7
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Placeholder for Stir
+        version: 2.11.1
+description: Service Testing in Ruby
 email:
 - umair.chagani@manheim.com
+- wallace.harwood@manheim.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/stir.rb
+- lib/stir/all.rb
+- lib/stir/base.rb
+- lib/stir/base/client.rb
+- lib/stir/base/configuration.rb
+- lib/stir/base/response.rb
+- lib/stir/config.rb
+- lib/stir/config/dependencies.yml
+- lib/stir/core_ext/string.rb
+- lib/stir/rest.rb
+- lib/stir/rest/endpoints.rb
+- lib/stir/rest/rest_client.rb
+- lib/stir/rest/rest_configuration.rb
+- lib/stir/soap.rb
+- lib/stir/soap/operations.rb
+- lib/stir/soap/soap_client.rb
+- lib/stir/soap/soap_configuration.rb
+- lib/stir/soap/soap_response.rb
 - lib/stir/version.rb
-- stir.gemspec
 homepage: https://github.com/manheim/stir
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Are you GETting what I'm POSTing?
 rdoc_options: []
 require_paths:
 - lib
@@ -83,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -91,8 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Placeholder for Stir
+summary: stir
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

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

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.1.3
-before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 uchagani
-
-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

@@ -1,41 +0,0 @@
-# Stir
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stir`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'stir'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install stir
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stir.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

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

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

data/stir.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'stir/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "stir"
-  spec.version       = Stir::VERSION
-  spec.authors       = ["uchagani"]
-  spec.email         = ["umair.chagani@manheim.com"]
-
-  spec.summary       = %q{Placeholder for Stir}
-  spec.description   = %q{Placeholder for Stir}
-  spec.homepage      = "https://github.com/manheim/stir"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end