service_contract_webmock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59e4650bf65a0018ea8b8efcab72e01cb81a60c9
+  data.tar.gz: 6cf0fa47ae94be22429ea8b48430c510315caf9a
+SHA512:
+  metadata.gz: 5f38f725beafa855ca724e5103160a6730044b89f3ddf179f66c3f281801623c7a252c1e3d824800cdc7f0863f435e3962ec09963cd3f28e2a99d54aaa5de605
+  data.tar.gz: 272ded90a1937744f125d8554c86a99aa9e5122bc4ad0508385d3ff970abf91c11a5cf7aeddfb7f4863eadf598b7ce2b9607e07c45b0d3759cbeab4018d02655

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Donald Plummer
+
+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,64 @@
+# ServiceContractWebmock
+
+A library for taking Avro contracts from ServiceContract and generating Webmock
+HTTP mocks to return fixture data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'service_contract_webmock'
+```
+
+## Usage
+
+Have some mocks for a service, like:
+
+```yaml
+# spec/mocks/foobar/orders.yml
+---
+- id: 1
+  customer_id: 1
+  status: Fulfilled
+```
+
+And assuming the `Foobar::Contract` has a schema defined for `Order`, then the
+following will create webmocks to return the order fixture.
+
+```ruby
+    ledger_contract = Foobar::Contract::Service.find("v1")
+    base_url = 'http://localhost:6002/api/v1'
+
+    Dir['spec/mocks/foobar/*.yml'].each do |filename|
+      name = File.basename(filename, '.yml')
+      resources = YAML.load_file(File.join(Rails.root, filename))
+      controller = ledger_contract.protocol(name.singularize)
+      next if controller.nil?
+
+      ServiceContractWebmock.webmock!(name, resources, controller, base_url)
+    end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake rspec` 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]/service_contract_webmock.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,10 @@
+require "service_contract_webmock/version"
+require "service_contract_webmock/field"
+require "service_contract_webmock/contract_matcher"
+require "service_contract_webmock/service_mock"
+
+module ServiceContractWebmock
+  def self.webmock!(name, resources, contract, base_url)
+    ServiceMock.new(name, resources, contract, base_url).webmock!
+  end
+end

data/lib/service_contract_webmock/contract_matcher.rb

@@ -0,0 +1,57 @@
+require 'cgi'
+require 'avro'
+
+module ServiceContractWebmock
+  class ContractMatcher
+    attr_reader :endpoint, :resources
+
+    def initialize(endpoint, resources)
+      @endpoint = endpoint
+      @resources = resources
+    end
+
+    INT = Avro::Schema::PrimitiveSchema.new(:int)
+
+    def to_regex
+      params = (fields + [Field.new('page', INT), Field.new('per_page', INT)]).map do |field|
+        "#{field.name}=#{field.value}&?"
+      end.join("|")
+      "(#{params})+"
+    end
+
+
+    def fields
+      @fields ||= endpoint.parameters.map do |param|
+        param.type.definition.fields.map do |field|
+          Field.new(field.name, field.type)
+        end
+      end.flatten
+    end
+
+    def field_int?(name)
+      fields.detect {|f| f.name == name}.try(:int?)
+    end
+
+    def extract_request(query)
+      params = CGI.parse(query)
+      fields.select {|field| field.name.in?(params.keys)}.each_with_object({}) do |field, acc|
+        data = params[field.name][0].split(',').flat_map {|value| field.convert(value)}
+        acc[field.name] = data
+      end
+    end
+
+    def found(query)
+      search = extract_request(query)
+      if search.empty?
+        resources
+      else
+        resources.select do |resource|
+          search.all? do |key, data|
+            key = "id" if key == "ids"
+            resource[key].in?(data)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/service_contract_webmock/field.rb

@@ -0,0 +1,58 @@
+module ServiceContractWebmock
+  class Field
+    attr_reader :name, :type, :value
+
+    def initialize(name, type)
+      @name = name
+      @type = type
+      @value = build_value(type)
+    end
+
+    def int?(t = type)
+      t.type_sym == :int ||
+        (t.type_sym == :array && t.items.type_sym == :int) ||
+        (t.type_sym == :union && t.schemas.any? {|sub| int?(sub)})
+    end
+
+    def boolean?(t = type)
+      t.type_sym == :boolean ||
+        (t.type_sym == :array && t.items.type_sym == :boolean) ||
+        (t.type_sym == :union && t.schemas.any? {|sub| boolean?(sub)})
+    end
+
+    def convert(value)
+      if int?
+        value.to_i
+      elsif boolean?
+        value == "true"
+      else
+        value
+      end
+    end
+
+    def build_value(type)
+      case type.type_sym
+      when :union
+        subtypes = type.schemas.map {|subtype| build_value(subtype)}
+        "(#{subtypes.join("|")})"
+      when :null
+        ""
+      when :int
+        "\\d+"
+      when :array
+        case type.items.type_sym
+        when :int
+          "[,\\d]+"
+        else
+          raise "unhandled array subtype #{type.items.type_sym}"
+        end
+      when :string
+        ".+"
+      when :boolean
+        "true|false"
+      else
+        raise "unhandled type #{type.type_sym}"
+      end
+    end
+  end
+end

data/lib/service_contract_webmock/service_mock.rb

@@ -0,0 +1,62 @@
+require 'webmock'
+
+module ServiceContractWebmock
+  class ServiceMock
+    attr_reader :name, :resources, :contract, :base_url
+
+    def initialize(name, resources, contract, base_url)
+      @name = name
+      @resources = resources
+      @contract = contract
+      @base_url = base_url
+    end
+
+    def webmock!
+      stub_index_request
+      stub_search_request
+      stub_show_request
+    end
+
+    def stub_request(method, path)
+      WebMock.stub_request(method, %r{#{base_url}/#{path}})
+    end
+
+    def stub_index_request
+      stub_request(:get, "#{name}\\.json\\??$")
+        .to_return(body: { name => resources }.to_json,
+                  headers: { 'Content-Type' => 'application/json' })
+    end
+
+    def stub_show_request
+      stub_request(:get, "#{name}/\\d+\\.json").
+        to_return do |request|
+          id = request.uri.path.scan(/\/(\d+)\.json/)[0][0].to_i
+          found = resources.select {|r| r['id'] == id}
+
+          if found.present?
+            {
+              body: { name => found }.to_json,
+              headers: { 'Content-Type' => 'application/json' }
+            }
+          else
+            {
+              body: { meta: { status: 404, errors: ['resource not found'] } }.to_json,
+              headers: { 'Content-Type' => 'application/json' },
+              status: 404
+            }
+          end
+        end
+    end
+
+    def stub_search_request
+      matcher = ContractMatcher.new(contract.endpoint("index"), resources)
+      stub_request(:get, "#{name}\\.json\\?#{matcher.to_regex}").
+        to_return do |request|
+          {
+            body: { name => matcher.found(request.uri.query) }.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          }
+        end
+    end
+  end
+end

data/lib/service_contract_webmock/version.rb

@@ -0,0 +1,3 @@
+module ServiceContractWebmock
+  VERSION = "0.1.0"
+end

data/service_contract_webmock.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_contract_webmock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "service_contract_webmock"
+  spec.version       = ServiceContractWebmock::VERSION
+  spec.authors       = ["Donald Plummer"]
+  spec.email         = ["donald.plummer@gmail.com"]
+
+  spec.summary       = %q{A library for generating webmock mocks with ServiceContract schemas}
+  spec.homepage      = "https://github.com/dplummer/service_contract_webmock"
+  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_dependency "avro"
+  spec.add_dependency "service_contract"
+  spec.add_dependency "webmock"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: service_contract_webmock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donald Plummer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: avro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: service_contract
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- donald.plummer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/service_contract_webmock.rb
+- lib/service_contract_webmock/contract_matcher.rb
+- lib/service_contract_webmock/field.rb
+- lib/service_contract_webmock/service_mock.rb
+- lib/service_contract_webmock/version.rb
+- service_contract_webmock.gemspec
+homepage: https://github.com/dplummer/service_contract_webmock
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: A library for generating webmock mocks with ServiceContract schemas
+test_files: []