mock5 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cc09164060a34461288bd4e5613a57179adfbd9
+  data.tar.gz: 65a3f5617db8ee8a94529e1017025a182bc2b631
+SHA512:
+  metadata.gz: e8823f3731b6c641e1cc9d4b6a773bf02f6bb44c974146bba2139e4823b0d74b3b3c4c6cde579ae1b5ad3bacdc97f7f51e7ea090f9c3f128911f38ef680817b0
+  data.tar.gz: c6bddb69871f5d54b5d35cd3ad6dc2ec2b04408b4546f31bfaad900cd396ee34dd8cfccae4f0386101d021dc74a14139c2c10eab13079bf1999e0ddbf2aa1457

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mock5.gemspec
+gemspec
+
+gem "bundler", "~> 1.5"
+gem "rspec",   "~> 2.14"
+gem "rake",    "~> 10.1"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pavel Pravosud
+
+MIT License
+
+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,81 @@
+# Mock5
+[![Gem Version](https://img.shields.io/gem/v/mock5.svg)][gem]
+[![Build Status](https://img.shields.io/travis/rwz/mock5.svg)][travis]
+[![Code Climate](https://img.shields.io/codeclimate/github/rwz/mock5.svg)][codeclimate]
+[gem]: https://rubygems.org/gems/mock5
+[travis]: http://travis-ci.org/rwz/mock5
+[codeclimate]: https://codeclimate.com/github/rwz/mock5
+
+Mock5 allows to mock external APIs with simple Sinatra Rake apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "mock5"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mock5
+
+## Usage
+
+```ruby
+SuccessfulRegistration = Mock5.mock("http://example.com") do
+  post "/users" do
+    # emulate successful registration
+    MultiJson.dump(
+      first_name: "Zapp",
+      last_name: "Brannigan",
+      email: "zapp@planetexpress.com"
+    )
+  end
+end
+
+UnsuccessfulRegistration = Mock5.mock("http://example.com") do
+  post "/users" do
+    halt 406, MultiJson.dump(
+      first_name: ["is too lame"],
+      email: ["is not unique"]
+    )
+  end
+end
+
+describe MyApi do
+  describe "successfull" do
+    around do |example|
+      Mock5.with_mounted SuccessfulRegistration do
+        example.call
+      end
+    end
+
+    it "allows user registration" do
+      expect{ MyApi.register_user }.not_to raise_error
+    end
+  end
+
+  describe "validation errors" do
+    around do |example|
+      Mock5.with_mounted UnsuccessfulRegistration do
+        example.call
+      end
+    end
+
+    it "returns errors" do
+      expect{ MyApi.register_user }.to raise_error(MyApi::ValidationError)
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/mock5.rb

@@ -0,0 +1,54 @@
+require "mock5/version"
+require "mock5/api"
+require "set"
+
+module Mock5
+  extend self
+
+  def mounted_apis
+    @_mounted_apis ||= Set.new
+  end
+
+  def mock(*args, &block)
+    Api.new(*args, &block)
+  end
+
+  def mount(*apis)
+    apis.each do |api|
+      if mounted_apis.add?(api)
+        registry.register_request_stub api.request_stub
+      end
+    end
+  end
+
+  def unmount(*apis)
+    apis.each do |api|
+      if mounted_apis.delete?(api)
+        registry.remove_request_stub api.request_stub
+      end
+    end
+  end
+
+  def mounted?(*apis)
+    apis.to_set.subset?(mounted_apis)
+  end
+
+  def with_mounted(*apis)
+    mount *apis
+    yield
+  ensure
+    unmount *apis
+  end
+
+  def unmount_all!
+    unmount *mounted_apis
+  end
+
+  alias_method :reset!, :unmount_all!
+
+  private
+
+  def registry
+    WebMock::StubRegistry.instance
+  end
+end

data/lib/mock5/api.rb

@@ -0,0 +1,59 @@
+require "uri"
+require "sinatra"
+require "webmock"
+
+module Mock5
+  class Api
+    attr_reader :endpoint, :app
+
+    def initialize(endpoint=nil, &block)
+      @app = Sinatra.new(&block)
+      @endpoint = normalize_endpoint(endpoint)
+    end
+
+    def request_stub
+      @request_stub ||= WebMock::RequestStub.new(:any, endpoint).tap{ |s| s.to_rack(app) }
+    end
+
+    private
+
+    def normalize_endpoint(endpoint)
+      case endpoint
+      when nil
+        /.*/
+      when String
+        normalize_string_endpoint(endpoint)
+      when Regexp
+        endpoint
+      else
+        raise ArgumentError, "Endpoint should hbe string or regexp"
+      end
+    end
+
+    def normalize_string_endpoint(endpoint)
+      uri = URI.parse(endpoint)
+
+      if uri.scheme !~ /\Ahttps?/
+        raise ArgumentError, "Endpoint should be a valid URL"
+      elsif uri.path != ?/ && !uri.path.empty?
+        raise ArgumentError, "Endpoint URL should not include path"
+      end
+
+      uri.path = ""
+      endpoint = Regexp.escape(uri.to_s)
+
+      Regexp.new("\\A#{endpoint}\/#{app_paths_regex}\\z")
+    end
+
+    def app_paths_regex
+      regexes = app.routes.values.flatten.select{ |v| Regexp === v }
+      paths = regexes.map{ |regex| regex.source[3..-3] }
+
+      return ".*" if paths.empty?
+
+      paths = paths.one?? paths.first : %{(?:#{paths.join("|")})}
+
+      "#{paths}(?:\\?.*)?"
+    end
+  end
+end

data/lib/mock5/version.rb

@@ -0,0 +1,3 @@
+module Mock5
+  VERSION = "1.0.1".freeze
+end

data/mock5.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mock5/version"
+
+Gem::Specification.new do |spec|
+  spec.name                  = "mock5"
+  spec.version               = Mock5::VERSION
+  spec.authors               = ["Pavel Pravosud"]
+  spec.email                 = ["pavel@pravosud.com"]
+  spec.summary               = "Mock APIs using Sinatra"
+  spec.description           = "Create and manage API mocks with Sinatra"
+  spec.homepage              = "https://github.com/rwz/mock5"
+  spec.license               = "MIT"
+  spec.files                 = `git ls-files -z`.split("\x0")
+  spec.test_files            = spec.files.grep(/^spec/)
+  spec.require_path          = "lib"
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_dependency "webmock", "~> 1.15"
+  spec.add_dependency "sinatra", "~> 1.4"
+end

data/spec/mock5_api_spec.rb

@@ -0,0 +1,71 @@
+require "mock5/api"
+require "rack/mock"
+
+describe Mock5::Api do
+  describe "#endpoint" do
+    it "matches all by default" do
+      expect(subject.endpoint).to eq(/.*/)
+    end
+
+    it "can be specified as a regex" do
+      api = described_class.new(/foo/)
+      expect(api.endpoint).to eq(/foo/)
+    end
+
+    it "can be specified as a valid url without path" do
+      api = described_class.new("http://example.com")
+      expect(api.endpoint).to eq(%r(\Ahttp://example\.com/.*\z))
+    end
+
+    it "can not be specified as a valid url with path" do
+      expect{ described_class.new("http://example.com/foo") }
+        .to raise_error(ArgumentError, "Endpoint URL should not include path")
+    end
+
+    it "can not be specified as a invalid url string" do
+      expect{ described_class.new("foo") }
+        .to raise_error(ArgumentError, "Endpoint should be a valid URL")
+    end
+
+    it "can not be specified by anything else" do
+      [false, :foo, 123].each do |invalid_endpoint|
+        expect{ described_class.new(invalid_endpoint) }
+          .to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#app" do
+    it "is a Class" do
+      expect(subject.app).to be_kind_of(Class)
+    end
+
+    it "is a Sinatra Rack app" do
+      expect(subject.app.superclass).to eq(Sinatra::Base)
+    end
+
+    describe "configuration" do
+      subject do
+        described_class.new do
+          get "/hello/:what" do |what|
+            "Hello, #{what.capitalize}"
+          end
+        end
+      end
+
+      let(:server){ Rack::Server.new(app: subject.app) }
+      let(:mock_request){ Rack::MockRequest.new(server.app) }
+
+      it "can be configures by a block" do
+        response = mock_request.get("/hello/world")
+        expect(response.body.to_s).to eq("Hello, World")
+      end
+    end
+  end
+
+  describe "#request_stub" do
+    it "returns a request stub" do
+      expect(subject.request_stub).to be_kind_of(WebMock::RequestStub)
+    end
+  end
+end

data/spec/mock5_spec.rb

@@ -0,0 +1,167 @@
+require "mock5"
+
+describe Mock5 do
+  describe ".mock" do
+    it "creates an Api" do
+      block = ->{}
+      expect(described_class::Api).to receive(:new).with(/foo/, &block)
+      described_class.mock /foo/, &block
+    end
+
+    it "returns an Api" do
+      expect(described_class.mock).to be_kind_of(described_class::Api)
+    end
+  end
+
+  describe "API mgmt" do
+    before do
+      WebMock::StubRegistry.instance.reset!
+      described_class.instance_exec do
+        if instance_variable_defined?(:@_mounted_apis)
+          remove_instance_variable(:@_mounted_apis)
+        end
+      end
+    end
+
+    let(:mounted_apis){ described_class.mounted_apis }
+    let(:api){ described_class.mock }
+    let(:another_api){ described_class.mock }
+
+    describe ".mount" do
+      it "mounts an api" do
+        described_class.mount api
+        expect(mounted_apis).to include(api)
+      end
+
+      it "mounts an api only once" do
+        10.times{ described_class.mount api }
+        expect(mounted_apis).to have(1).item
+      end
+
+      it "mounts several APIs at once" do
+        described_class.mount api, another_api
+        expect(mounted_apis).to include(api)
+        expect(mounted_apis).to include(another_api)
+      end
+    end
+
+    describe ".unmount" do
+      before{ described_class.mount api }
+
+      it "unmounts mounted api" do
+        described_class.unmount api
+        expect(mounted_apis).to be_empty
+      end
+
+      it "unmounts api only once" do
+        10.times{ described_class.unmount api }
+        expect(mounted_apis).to be_empty
+      end
+
+      it "unmounts several APIs at once" do
+        described_class.mount another_api
+        expect(mounted_apis).to have(2).apis
+        described_class.unmount api, another_api
+        expect(mounted_apis).to be_empty
+      end
+
+      it "only unmount specified api" do
+        described_class.mount another_api
+        described_class.unmount api
+        expect(mounted_apis).to include(another_api)
+      end
+    end
+
+    describe ".unmount_all!" do
+      before do
+        3.times{ described_class.mount described_class.mock }
+      end
+
+      it "unmounts all currently mounted apis" do
+        expect(mounted_apis).to have(3).apis
+        described_class.unmount_all!
+        expect(mounted_apis).to be_empty
+      end
+
+      it "has .reset! alias" do
+        expect(mounted_apis).to have(3).apis
+        described_class.reset!
+        expect(mounted_apis).to be_empty
+      end
+    end
+
+    describe ".mounted?" do
+      before{ described_class.mount api }
+
+      it "returns true if api is currently mounted" do
+        expect(described_class.mounted?(api)).to be_true
+      end
+
+      it "returns false if api is currently not mounted" do
+        expect(described_class.mounted?(another_api)).to be_false
+      end
+
+      it "returns true only when ALL api are mounted" do
+        action = ->{ described_class.mount another_api }
+        result = ->{ described_class.mounted? api, another_api }
+        expect(&action).to change(&result).from(false).to(true)
+      end
+    end
+
+    describe ".with_mounted" do
+      it "temporary mounts an API" do
+        action = -> do
+          described_class.with_mounted api do
+            expect(mounted_apis).to include(api)
+          end
+        end
+
+        expect(mounted_apis).to be_empty
+        expect(&action).not_to change(mounted_apis, :empty?)
+      end
+    end
+
+    describe "stubbing" do
+      def get(url)
+        Net::HTTP.get(URI(url))
+      end
+
+      def post(url, params={})
+        Net::HTTP.post_form(URI(url), params).body
+      end
+
+      let(:api) do
+        described_class.mock "http://example.com" do
+          get "/index.html" do
+            "index.html"
+          end
+
+          post "/submit/here" do
+            "submit"
+          end
+        end
+      end
+
+      let(:another_api) do
+        described_class.mock "http://example.com" do
+          post "/foo/:foo" do
+            params["foo"]
+          end
+
+          get "/bar/:bar" do
+            params["bar"]
+          end
+        end
+      end
+
+      before{ described_class.mount api, another_api }
+
+      it "stubs remote apis" do
+        expect(get("http://example.com/index.html?foo=bar")).to eq("index.html")
+        expect(post("http://example.com/submit/here?foo=bar")).to eq("submit")
+        expect(post("http://example.com/foo/bar?fizz=buzz")).to eq("bar")
+        expect(get("http://example.com/bar/foo")).to eq("foo")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: mock5
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Pavel Pravosud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Create and manage API mocks with Sinatra
+email:
+- pavel@pravosud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mock5.rb
+- lib/mock5/api.rb
+- lib/mock5/version.rb
+- mock5.gemspec
+- spec/mock5_api_spec.rb
+- spec/mock5_spec.rb
+homepage: https://github.com/rwz/mock5
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Mock APIs using Sinatra
+test_files:
+- spec/mock5_api_spec.rb
+- spec/mock5_spec.rb