flipp-mockserver-client 0.1.0

data/lib/mockserver/model/forward.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './enum'
+
+#
+# A class to model a forwarding on a request.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Enum for a scheme used in a forward request
+  class Scheme < SymbolizedEnum
+    def allowed_values
+      [:HTTP, :HTTPS]
+    end
+  end
+
+  # Model for forwarding
+  class Forward < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :host, default: 'localhost'
+    property :port, default: 80
+    property :scheme, default: 'HTTP'
+
+    coerce_key :host, String
+    coerce_key :scheme, Scheme
+  end
+
+  # DSL methods for forward
+  module DSL
+    def forward(&_)
+      obj = Forward.new
+      yield obj if block_given?
+      obj
+    end
+
+    alias_method :http_forward, :forward
+  end
+end

data/lib/mockserver/model/header.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './array_of'
+
+#
+# A class to model headers in payloads.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # A class that only stores strings
+  class Strings < ArrayOf
+    def child_class
+      String
+    end
+  end
+
+  # Model for header
+  class Header < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :name, required: true
+    property :values, default: Strings.new([])
+
+    coerce_key :name, String
+    coerce_key :values, Strings
+  end
+
+  # A collection that only stores headers
+  class Headers < ArrayOf
+    def child_class
+      Header
+    end
+  end
+
+  # DSL methods for header
+  module DSL
+    def header(key, *value)
+      Header.new(name: key, values: value)
+    end
+  end
+end

data/lib/mockserver/model/parameter.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './array_of'
+
+#
+# A class to model parameters in payloads.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # A class that only stores strings
+  class Strings < ArrayOf
+    def child_class
+      String
+    end
+  end
+
+  # Model for parameter
+  class Parameter < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :name, required: true
+    property :values, default: Strings.new([])
+
+    coerce_key :name, String
+    coerce_key :values, Strings
+  end
+
+  # A collection that only stores parameters
+  class Parameters < ArrayOf
+    def child_class
+      Parameter
+    end
+  end
+
+  # DSL methods for parameter
+  module DSL
+    def parameter(key, *value)
+      Parameter.new(name: key, values: value)
+    end
+  end
+end

data/lib/mockserver/model/request.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './parameter'
+require_relative './header'
+require_relative './cookie'
+require_relative './body'
+require_relative './enum'
+require 'base64'
+#
+# A class to model a request in an expectation.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Enum for HTTP methods
+  class HTTPMethod < SymbolizedEnum
+    def allowed_values
+      [:GET, :POST, :PUT, :DELETE, :PATCH]
+    end
+  end
+
+  # Request model
+  class Request < Hashie::Trash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    ALLOWED_METHODS = [:GET, :POST, :PUT, :DELETE, :PATCH]
+
+    property :method, required: true, default: :GET
+    property :path, required: true, default: ''
+    property :query_string_parameters, default: Parameters.new([])
+    property :cookies, default: Cookies.new([])
+    property :headers, default: Headers.new([])
+    property :body
+
+    coerce_key :method, HTTPMethod
+    coerce_key :path, String
+    coerce_key :query_string_parameters, Parameters
+    coerce_key :cookies, Cookies
+    coerce_key :headers, Headers
+    coerce_key :body, String
+
+    # Creates a request from a hash
+    # @param payload [Hash] a hash representation of the request
+    def populate_from_payload(payload)
+      @request = payload[MockServer::HTTP_REQUEST]
+      @request = Request.new(symbolize_keys(@request)) if @request
+    end
+  end
+
+  # Class to store a list of mocks - useful for modeling retrieve endpoint result
+  class Requests < ArrayOf
+    # Code is used to store HTTP status code returned from retrieve endpoint
+    attr_accessor :code
+
+    def child_class
+      Request
+    end
+  end
+
+  # DSL methods related to requests
+  module DSL
+    def request(method, path, &_)
+      obj = Request.new(method: method, path: path)
+      yield obj if block_given?
+      obj
+    end
+
+    def request_from_json(payload)
+      request = Request.new(symbolize_keys(payload))
+      yield request if block_given?
+      request
+    end
+
+    alias_method :http_request, :request
+  end
+end

data/lib/mockserver/model/response.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+require_relative './body'
+require_relative './delay'
+require_relative './header'
+require_relative './cookie'
+require 'base64'
+
+#
+# A class to model a response in an expectation.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Model for a mock response
+  class Response < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :status_code, default: 200
+    property :cookies, default: Cookies.new([])
+    property :headers, default: Headers.new([])
+    property :delay
+    property :body
+
+    coerce_key :cookies, Cookies
+    coerce_key :headers, Headers
+    coerce_key :delay, Delay
+    coerce_key :body, String
+  end
+
+  # DSL Methods for a response
+  module DSL
+    def response(&_)
+      obj = Response.new
+      yield obj if block_given?
+      obj
+    end
+
+    def decode(string)
+      Base64.decode64(string)
+    end
+
+    alias_method :http_response, :response
+  end
+end

data/lib/mockserver/model/times.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './enum'
+
+#
+# A class to model the number of times an expectation should be respected.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Enum for boolean values since Ruby does not have this by default
+  class Boolean < Enum
+    def allowed_values
+      [true, false]
+    end
+
+    def !
+      !@value
+    end
+
+    def initialize(supplied_value)
+      @value = pre_process_value(supplied_value)
+    end
+  end
+
+  # Model for times class
+  class Times < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :remaining_times, default: 0
+    property :unlimited, default: false
+
+    coerce_key :unlimited, Boolean
+  end
+
+  # DSL methods related to times
+  module DSL
+    def unlimited
+      Times.new(unlimited: true)
+    end
+
+    def once
+      Times.new(remaining_times: 1)
+    end
+
+    def exactly(num)
+      Times.new(remaining_times: num)
+    end
+
+    def at_least(num)
+      Times.new(remaining_times: num, unlimited: true)
+    end
+
+    def times(&_)
+      obj = once
+      yield obj if block_given?
+      obj
+    end
+  end
+end

data/lib/mockserver/proxy_client.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+require_relative './abstract_client'
+
+#
+# The client used to interact with the proxy server.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+class MockServer::ProxyClient < MockServer::AbstractClient
+end

data/lib/mockserver/utility_methods.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+require 'active_support/inflector'
+require 'json'
+
+#
+# A module that has common utility methods used by this project
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::UtilityMethods
+  # Does the following filter/transform operations on a hash
+  # - exclude null or empty valued keys from the hash
+  # - camelize the keys of the hash
+  # @param obj [Object] an object which will be used to create the hash. Must support :to_hash method
+  # @return [Hash] the transformed hash
+  # rubocop:disable Style/MethodLength
+  # rubocop:disable Style/CyclomaticComplexity
+  def camelized_hash(obj)
+    obj = obj && obj.respond_to?(:to_hash) ? obj.to_hash : obj
+
+    if obj.is_a?(Hash)
+      obj.each_with_object({}) do |(k, v), acc|
+        is_empty         = v.nil? || (v.respond_to?(:empty?) ? v.empty? : false)
+        acc[camelize(k)] = camelized_hash(v) unless is_empty
+      end
+    elsif obj.respond_to?(:map)
+      obj.map { |element| camelized_hash(element) }
+    else
+      obj
+    end
+  end
+
+  # Converts keys to symbols
+  # @param hash [Hash] a hash
+  # @return [Hash] a copy of the hash where keys are symbols
+  def symbolize_keys(hash)
+    if hash.is_a?(Hash)
+      Hash[hash.map { |k, v| [k.to_s.underscore.to_sym, symbolize_keys(v)] }]
+    elsif hash.respond_to?(:map)
+      hash.map { |obj| symbolize_keys(obj) }
+    else
+      hash
+    end
+  end
+
+  # @param str [Object] an object to camelize the string representation of
+  # @return [String] the string converted to camelcase with first letter in lower case
+  def camelize(str)
+    str.to_s.camelize(:lower)
+  end
+
+  # Parse string response into JSON
+  # @param response [Response] from RestClient response
+  # @return [Hash] the parsed response or the object unmodified if parsing is not possible
+  def parse_string_to_json(response)
+    JSON.parse(response)
+  rescue JSON::ParserError
+    response
+  end
+end

data/lib/mockserver/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+# Version for this gem
+module MockServer
+  VERSION = '1.0.8.pre'
+end

data/mockserver-client.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mockserver/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'flipp-mockserver-client'
+  spec.version     = '0.1.0'
+  spec.authors     = ['original - Nayyara Samuel, James D Bloom', 'modified - Dennis Marcu']
+  spec.summary     = 'mockserver-client gem modified for Flipp'
+  spec.description = 'A Ruby Client for MockServer that enables easy mocking of any system you integrate with via HTTP or HTTPS (i.e. services, web sites, etc) modified to work with multiple Fipp requests'
+
+  spec.required_ruby_version     = '>= 1.9'
+  spec.required_rubygems_version = '~> 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.8'
+  spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'rubocop', '~> 0.23'
+
+  spec.add_dependency 'hashie', '~> 3.0'
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'json_pure', '~> 1.8'
+  spec.add_dependency 'activesupport', '~> 4.1'
+  spec.add_dependency 'rest-client', '~> 1.7'
+  spec.add_dependency 'logging_factory', '~> 0.0.2'
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'colorize', '~> 0.7'
+end

data/pom.xml

@@ -0,0 +1,116 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>org.mock-server</groupId>
+        <artifactId>mockserver</artifactId>
+        <version>3.10.5-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>mockserver-client-ruby</artifactId>
+    <name>MockServer Ruby Client</name>
+    <description>A ruby client for the MockServer</description>
+    <url>http://www.mock-server.com</url>
+
+    <properties>
+        <skipRubyRelease>true</skipRubyRelease>
+    </properties>
+
+    <build>
+        <plugins>
+            <!-- run mock server for ruby client tests -->
+            <plugin>
+                <groupId>${project.groupId}</groupId>
+                <artifactId>mockserver-maven-plugin</artifactId>
+                <version>${project.version}</version>
+                <configuration>
+                    <logLevel>WARN</logLevel>
+                    <serverPort>8098</serverPort>
+                    <proxyPort>9102</proxyPort>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>pre-test</id>
+                        <phase>generate-test-sources</phase>
+                        <goals>
+                            <goal>start</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>post-test</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>stop</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <!-- run ruby bundle build and install -->
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>1.4.0</version>
+                <executions>
+                    <execution>
+                        <id>bundle_install</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                        <configuration>
+                            <executable>bundle</executable>
+                            <arguments>
+                                <argument>install</argument>
+                                <argument>--path</argument>
+                                <argument>vendor/bundle</argument>
+                            </arguments>
+                            <environmentVariables>
+                                <BUNDLE_GEMFILE>${basedir}/Gemfile</BUNDLE_GEMFILE>
+                            </environmentVariables>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>ruby_make</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                        <configuration>
+                            <skip>${skipTests}</skip>
+                            <executable>bundle</executable>
+                            <arguments>
+                                <argument>exec</argument>
+                                <argument>rake</argument>
+                                <argument>build</argument>
+                                <argument>spec</argument>
+                            </arguments>
+                            <environmentVariables>
+                                <BUNDLE_GEMFILE>${basedir}/Gemfile</BUNDLE_GEMFILE>
+                            </environmentVariables>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>ruby_release</id>
+                        <phase>deploy</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                        <configuration>
+                            <skip>${skipRubyRelease}</skip>
+                            <executable>bundle</executable>
+                            <arguments>
+                                <argument>exec</argument>
+                                <argument>rake</argument>
+                                <argument>release</argument>
+                            </arguments>
+                            <environmentVariables>
+                                <BUNDLE_GEMFILE>${basedir}/Gemfile</BUNDLE_GEMFILE>
+                            </environmentVariables>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>