stub_requests 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1bf4b020989fae9d4edf349c5eddb3c5aa3447ccb14f316e5e016be19636205f
+  data.tar.gz: 40f01c2d62daa3957f5d0331abbbca3df824f1300236cc744541427e696c9bd0
+SHA512:
+  metadata.gz: 98f4dfc578779e820b115309a966d412054927fdb7a58487cc11dcd221e3bee013fdc772917324285039000815f8dc9d05788a8aced3b43e4e72d044de0927e1
+  data.tar.gz: 05376f6ec2b7ec7f4974af7c635fd6f6596f5b49beed93e2cedcb0f51db147574757bd6ffbe75bf5259123e309dae7aa0d0677f0063022ef532fc25a3cc8caa3

data/.codeclimate.yml

@@ -0,0 +1,23 @@
+---
+version: '2'
+plugins:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  fixme:
+    enabled: true
+  flog:
+    enabled: true
+  markdownlint:
+    enabled: true
+  reek:
+    enabled: true
+    config:
+      file: .reek.yml
+  rubocop:
+    enabled: true
+    channel: rubocop-0-63
+    config:
+      file: .rubocop.yml

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.gitignore

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

data/.mdlrc

@@ -0,0 +1 @@
+rules "~MD013"

data/.reek.yml

@@ -0,0 +1,12 @@
+# Auto generated by Reeks --todo flag
+---
+detectors:
+  ManualDispatch:
+    exclude:
+    - Object#blank?
+  Attribute:
+    exclude:
+    - StubRequests#logger
+
+exclude_paths:
+  - vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,112 @@
+require:
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - "Rakefile"
+    - "lib/**/*"
+    - "bin/**/*"
+    - "spec/**/*"
+  Exclude:
+    - "lib/stub_requests/core_ext/**/*"
+    - "Gemfile.lock"
+    - "bin/setup"
+
+Lint/HandleExceptions:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 38
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 13
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - '**/spec/**/*.rb'
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Naming/AccessorMethodName:
+  Enabled: true
+
+Naming/ConstantName:
+  Enabled: true
+
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - '**/Gemfile'
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - ex
+
+RSpec/AlignLeftLetBrace:
+  Enabled: true
+
+RSpec/FilePath:
+  Enabled: true
+  Exclude:
+    - 'spec/stub_requests/webmock_builder_spec.rb'
+
+RSpec/NestedGroups:
+  Max: 4
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: true
+
+Style/GlobalVars:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+Style/TernaryParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses_when_complex
+  AllowSafeAssignment: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.3

data/.simplecov

@@ -0,0 +1,23 @@
+require "simplecov-json"
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::JSONFormatter,
+])
+
+SimpleCov.configure do
+  command_name "RSpec"
+  refuse_coverage_drop
+  minimum_coverage_by_file 80
+  maximum_coverage_drop 5
+  at_exit do
+    SimpleCov.result.format!
+  end
+end
+
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/bin/'
+  add_filter '/gemfiles/'
+  add_filter '/examples/'
+end

data/.travis.yml

@@ -0,0 +1,37 @@
+language: ruby
+cache: bundler
+env:
+  matrix:
+    - COV=false
+  global:
+    - CC_TEST_REPORTER_ID=8ef08c06ceb394c164b97b5d4c5874b016b1a85a760cf05521503dac6dde0eeb
+    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct;
+      else git log -1 --skip 1 --pretty=format:%ct; fi)
+before_install:
+  - gem install bundler -v 2.0.1
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+before_script:
+  - "./cc-test-reporter before-build"
+script:
+  - if [[ "${COV}" = "true" ]]; then bundle exec rubocop -P; fi;
+  - if [[ "${COV}" = "true" ]]; then bundle exec reek .; fi;
+  - bundle exec rspec
+after_script:
+  - if [[ "${COV}" = "true" ]]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi;
+rvm:
+  - 2.3.7
+  - 2.4.5
+matrix:
+  fast_finish: true
+  include:
+    - rvm: 2.5.3
+      env: COV=true
+deploy:
+  provider: rubygems
+  api_key:
+    secure: EhdN7pRCvnoI/WYKo4/B4NzzT+OAswhlDrW56KK0CmKmR8SrEBOwBB10MxEmOM24cMSrZGYb1MQCGqQ7yt2Erx4Z2E6OVSAlUIlWjhNaFhyTFmxQB5pP3ulH5gGJuw6BYFomPTW504BKIMay/IzMnbcx9fORsKlckU9W0WC7jMrVkmhPrMRBrrxaLW7ZJuV3CxsdVVLm4c1CQiGu3Lm6oXPBGe2L1Ctw+q/BHQvXJIDE3smJ4aNZBSpQouzlw8HSJd3Poq7m8AP8foc7oA9brrx55to3dBkhVJxeZa7fvYP+3J3IZUVL+5mOr+QXwivZnqL2NmIOZZjOisf1njQO5Mk4v/HM5wBgi8R5RMBp55A6iz7ZPca9Tj5DoVEINGfncQ0JGAeovx2/Z/g9/Dj3zr2kU9fI51tomnSJbmgxZ4wzwTP8afUdGEa013AeVcGQlXUnBljsU4MttVXufXPptWm9ABtN2oTvPNs4pYzXliGjT97d1TS4hhf7I+Fd6yUXPOyNokmrVMT68ZWou3IBM+gm8He41oNe9l/17vevG+GpOMjPo54ASpTuOc6DcuWGJPkvBPZ3ijz7kn3c/YT+LpSy7zxwjn3QA4VGj4W5JzlsLmlCSBsan9X8SIgmqY41Z/J/R86L+ndW+TY8m4oxl86LF0J2w0JAX97pcyD4Bo4=
+  gem: stub_requests
+  on:
+    tags: true
+    repo: mhenrixon/stub_requests

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb - README.md

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,64 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stub_requests.gemspec
+gemspec
+
+gem "rb-readline"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mikael Henriksson <mikael@zoolutions.se> (mhenrixon)
+
+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,138 @@
+# StubRequests
+
+## Badges
+
+[![Build Status](https://travis-ci.org/mhenrixon/stub_requests.svg?branch=master)](https://travis-ci.org/mhenrixon/stub_requests) [![Maintainability](https://api.codeclimate.com/v1/badges/c9217e458c2a77fff1bc/maintainability)](https://codeclimate.com/github/mhenrixon/stub_requests/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c9217e458c2a77fff1bc/test_coverage)](https://codeclimate.com/github/mhenrixon/stub_requests/test_coverage)
+
+This gem attempts to solve a problem I've had for the time with WebMock.
+
+When something changes, I have to update every single stub_request.
+
+This gem allows me to only update the crucial parts while abstracting away things like service URI's, endpoint definitions and focus on the important things.
+
+This is achieve by keeping a registry over the service endpoints.
+
+<!-- MarkdownTOC -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Future Improvements](#future-improvements)
+  - [API Client Gem](#api-client-gem)
+  - [Debugging](#debugging)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+<!-- /MarkdownTOC -->
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "stub_requests"
+```
+
+And then execute:
+
+`bundle`
+
+Or install it yourself as:
+
+`gem install stub_requests`
+
+## Usage
+
+To use the gem we need to register some service endpoints. In the following example we are connecting to a rails inspired service.
+
+The naming of the `service_id` and `endpoint_id`'s is irrelevant. This is just how we look things up in the registry.
+
+```ruby
+StubRequests.register_service(:google_ads, "https://api.google.com/v5") do
+  register(:index, :get, "ads")
+  register(:show, :get, "ads/:id")
+  register(:update, :patch, "ads/:id")
+  register(:create, :post, "ads")
+  register(:destroy, :delete, "ads/:id")
+end
+```
+
+Now we have a list of endpoints we can stub.
+
+```ruby
+StubRequests.stub_endpoint(:google_ads, :index)
+            .to_return(code: 204, body: "")
+
+# This is the equivalent of doing the following in WebMock
+Settings.google_ads_base_uri = "https://api.google.com/v5"
+
+WebMock.stub_request(:get, "#{Settings.google_ads_base_uri}/ads")
+       .to_return(status: 204, body: "")
+```
+
+So far so good but not much of a gain yet. The real power comes when we don't have to interpolate a bunch of URLs all the time.
+
+```ruby
+StubRequests.stub_endpoint(:google_ads, :update, id: 1) do
+  with(body: request_body.to_json)
+  to_return(code: 200, body: response_body.to_json)
+end
+
+# This is the equivalent of doing the following in WebMock
+Settings.google_ads_base_uri = "https://api.google.com/v5"
+
+WebMock.stub_request(:patch, "#{Settings.google_ads_base_uri}/ads/#{id}")
+       .with(body: request_body.to_json)
+       .to_return(status: 200, body: response_body.to_json)
+```
+
+First of all we reduce a lot of duplication.
+
+Imagine a code base with thousands of stubbed request. You always have to look at the defined URL to understand which request is actually being called.
+
+Madness!!
+
+## Future Improvements
+
+### API Client Gem
+
+Since we have a service + endpoint registry, I was thinking it might make
+sense to make this into an API client. Not sure yet, maybe this will become multiple gems in the future so that someone can pick and choose.
+
+Anyway, the idea was to provide endpoint calls in production and stubbed
+requests in tests using the same registry.
+
+### Debugging
+
+I want to provide information about where a request stub was created from. In the project I am currently working this would have saved me a days work already.
+
+## 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:
+[issues](https://github.com/mhenrixon/stub_requests).
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor Covenant](cc) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](mit).
+
+## Code of Conduct
+
+Everyone interacting in the StubRequests project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct](coc).
+
+[coc]:https://github.com/mhenrixon/stub_requests/blob/master/CODE_OF_CONDUCT.md
+[cc]: http://contributor-covenant.org
+[mit]: https://opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-merlot

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "stub_requests"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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/index.md

@@ -0,0 +1,37 @@
+# Welcome to GitHub Pages
+
+You can use the [editor on GitHub](https://github.com/mhenrixon/stub_requests/edit/master/index.md) to maintain and preview the content for your website in Markdown files.
+
+Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
+
+## Markdown
+
+Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
+
+```markdown
+Syntax highlighted code block
+
+# Header 1
+## Header 2
+### Header 3
+
+- Bulleted
+- List
+
+1. Numbered
+2. List
+
+**Bold** and _Italic_ and `Code` text
+
+[Link](url) and ![Image](src)
+```
+
+For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
+
+### Jekyll Themes
+
+Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/mhenrixon/stub_requests/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
+
+### Support or Contact
+
+Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.

data/lib/stub_requests/api.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module API abstraction to reduce the amount of WebMock.stub_request
+  #
+  # @note This module can either be used by its class methods
+  #   or included in say RSpec
+  #
+  module API
+    # extends "self"
+    # @!parse extend self
+    extend self
+
+    # :nodoc:
+    def self.included(base)
+      base.send(:extend, self)
+    end
+
+    # Register a service in the service registry
+    #
+    # @param [Symbol] service_id a descriptive id for the service
+    # @param [Symbol] service_uri the uri used to call the service
+    #
+    # @return [Service] a new service or a previously registered service
+    #
+    # :reek:UtilityFunction
+    def register_service(service_id, service_uri, &block)
+      service = ServiceRegistry.instance.register_service(service_id, service_uri)
+      Docile.dsl_eval(service.endpoint_registry, &block) if block.present?
+      service
+    end
+
+    #
+    # Stub a request to a registered service endpoint
+    #
+    # @param [Symbol] service_id the id of a registered service
+    # @param [Symbol] endpoint_id the id of a registered endpoint
+    # @param [Hash<Symbol>] uri_replacements a list of uri replacements
+    # @param [Hash<Symbol>] options
+    # @option options [optional, Hash<Symbol>] :request webmock request options
+    # @option options [optional, Hash<Symbol>] :response webmock response options
+    # @option options [optional, Array, Exception, StandardError, String] :error webmock error to raise
+    # @option options [optional, TrueClass] :timeout set to truthy to raise timeeout with webmock
+    #
+    # @example Stub a request to a registered service endpoint
+    #   register_stub(
+    #     :google_api,
+    #     :get_map_location,
+    #     { request: { headers: { "Accept" => "application/json" }}},
+    #     { response: { body: { id: "abyasdjasd", status: "successful" }}}
+    #   )
+    #
+    # @see #stub_http_request
+    # @return [WebMock::RequestStub] a mocked request
+    #
+    # :reek:UtilityFunction
+    # :reek:LongParameterList { max_params: 5 }
+    def stub_endpoint(service_id, endpoint_id, uri_replacements = {}, options = {}, &callback)
+      service  = ServiceRegistry.instance.get_service!(service_id)
+      endpoint = service.get_endpoint!(endpoint_id)
+      uri      = URI::Builder.build(service.uri, endpoint.uri_template, uri_replacements)
+
+      StubRequests::WebMockBuilder.build(endpoint.verb, uri, options, &callback)
+    end
+  end
+end