stub_requests 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc8e6e325329977ce50cecf33f1261c7194afdfa9dd63f2d18627fd9228aaf2b
-  data.tar.gz: d581dbdc2d0c56d55e634754876b62a2ee38cad988c1b9474971308bf51c08e5
+  metadata.gz: 521fcf52479aee73bde3bacc79d67c6d4a45032000b5db6c52aa74d11f96135b
+  data.tar.gz: a762b8db4bda856bf186c50974c16f2ca0668d9e3fe5dc77c84d6e096de938f6
 SHA512:
-  metadata.gz: 516de1eae065073fb7e97d73793283943e22d2b328de5d1cd870aefbb068e3f8b3d7c149280a186c3c19ae9d84d2aaa6cdb7dc3a53532f5dec3776225804a102
-  data.tar.gz: 0bae1c15d8fa2101f1c205d0424524d626ea0599cfe07e15da374bdee39891759a57f53b379459e7e97d7b583430a9cde2d5ad15b8a3f9ec3d67b6b9b854f47f
+  metadata.gz: 94eaf0edd7a35e83f6321189e775e6e90290ddfac63117e60f07b86aea9b84fffa6b363f8014e6629ff6214324c99d8b1686a113cd5f3a89ed8199191a200a18
+  data.tar.gz: 10084a0c36f0e7c857f19615312fe018fab42272468a72a74e62747113b15953e2706f25965d81f80f50a7d21f56b339d2c37d58b696ad41c274eb63cefbccce

data/.gitignore

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

data/.reek.yml

@@ -11,3 +11,4 @@ detectors:
 exclude_paths:
   - vendor/bundle
   - gemfiles
+  - lib/stub_requests/core_ext/

data/.rubocop.yml

@@ -12,17 +12,15 @@ AllCops:
     - "lib/**/*"
     - "bin/**/*"
     - "spec/**/*"
+    - ".simplecov"
   Exclude:
     - "lib/stub_requests/core_ext/**/*"
     - "Gemfile.lock"
     - "bin/setup"
     - "gemfiles/**/*"
 
-Lint/HandleExceptions:
-  Enabled: true
-
-Lint/UselessAssignment:
-  Enabled: true
+Layout/IndentArray:
+  EnforcedStyle: consistent
 
 Metrics/AbcSize:
   Max: 38
@@ -37,7 +35,6 @@ Metrics/MethodLength:
   Max: 13
 
 Metrics/BlockLength:
-  Enabled: true
   Exclude:
     - '**/spec/**/*.rb'
     - '**/*.rake'
@@ -45,14 +42,7 @@ Metrics/BlockLength:
 Metrics/PerceivedComplexity:
   Max: 8
 
-Naming/AccessorMethodName:
-  Enabled: true
-
-Naming/ConstantName:
-  Enabled: true
-
 Naming/FileName:
-  Enabled: true
   Exclude:
     - '**/Gemfile'
 
@@ -60,55 +50,63 @@ Naming/UncommunicativeMethodParamName:
   AllowedNames:
     - ex
 
-RSpec/AlignLeftLetBrace:
+AlignLeftLetBrace:
   Enabled: true
 
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - if
+    - given
+    - for
+    - and
+
+RSpec/EmptyExampleGroup:
+  Enabled: false
+  CustomIncludeMethods:
+    - let!
+    - specfify!
+
 RSpec/FilePath:
-  Enabled: true
   Exclude:
-    - 'spec/stub_requests/webmock_builder_spec.rb'
+    - spec/stub_requests/webmock/builder_spec.rb
 
-RSpec/NestedGroups:
-  Max: 4
-  Enabled: true
+RSpec/ImplicitSubject:
+  Enabled: false
+  EnforcedStyle: single_statement_only
 
-Style/FrozenStringLiteralComment:
-  Enabled: true
+RSpec/MultipleDescribes:
+  Exclude:
+    - spec/stub_requests/core_ext/object/blank_spec.rb
 
-Style/Documentation:
-  Enabled: true
+RSpec/NamedSubject:
+  Exclude:
+    - spec/stub_requests/core_ext/object/blank_spec.rb
 
-Style/GlobalVars:
-  Enabled: true
+RSpec/NestedGroups:
+  Max: 4
 
 Style/ModuleFunction:
-  Enabled: false
+  EnforcedStyle: extend_self
 
 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/.simplecov

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require "simplecov-json"
 
-SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::HTMLFormatter,
-  SimpleCov::Formatter::JSONFormatter,
-])
+SimpleCov.formatters =
+  SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter,
+  ])
 
 SimpleCov.configure do
   command_name "RSpec"
@@ -16,8 +19,11 @@ SimpleCov.configure do
 end
 
 SimpleCov.start do
-  add_filter '/spec/'
-  add_filter '/bin/'
-  add_filter '/gemfiles/'
-  add_filter '/examples/'
+  add_filter "/spec/"
+  add_filter "/bin/"
+  add_filter "/gemfiles/"
+  add_filter "/lib/stub_requests/core_ext/array/extract_options.rb"
+  add_filter "/lib/stub_requests/core_ext/class/attribute.rb"
+  add_filter "/lib/stub_requests/core_ext/kernel/singleton_class.rb"
+  add_filter "/lib/stub_requests/core_ext/module/redefine_method.rb"
 end

data/.yardopts

@@ -1 +1 @@
---no-private --output-dir docs lib/stub_requests/**/*.rb --markup-provider=redcarpet --markup=markdown - README.md
+--no-private --markup-provider=redcarpet --markup=markdown lib/stub_requests/**/*.rb - README.md

data/CHANGELOG.md

@@ -6,6 +6,8 @@
 
 **Merged pull requests:**
 
+- Allow older webmock versions [\#4](https://github.com/mhenrixon/stub_requests/pull/4) ([mhenrixon](https://github.com/mhenrixon))
+- Add docs folder [\#3](https://github.com/mhenrixon/stub_requests/pull/3) ([mhenrixon](https://github.com/mhenrixon))
 - Add docs folder and CHANGELOG.md [\#2](https://github.com/mhenrixon/stub_requests/pull/2) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v0.1.0](https://github.com/mhenrixon/stub_requests/tree/v0.1.0) (2019-02-01)
@@ -14,4 +16,5 @@
 - Add rough initial implementation [\#1](https://github.com/mhenrixon/stub_requests/pull/1) ([mhenrixon](https://github.com/mhenrixon))
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -16,9 +16,11 @@ This is achieve by keeping a registry over the service endpoints.
 
 - [Installation](#installation)
 - [Usage](#usage)
+  - [Register service endpoints](#register-service-endpoints)
+  - [Stubbing service endpoints](#stubbing-service-endpoints)
+  - [Metrics](#metrics)
 - [Future Improvements](#future-improvements)
   - [API Client Gem](#api-client-gem)
-  - [Debugging](#debugging)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -54,6 +56,9 @@ To use the gem we need to register some service endpoints. In the following exam
 
 The naming of the `service_id` and `endpoint_id`'s is irrelevant. This is just how we look things up in the registry.
 
+<a id="register-service-endpoints"></a>
+### Register service endpoints
+
 ```ruby
 StubRequests.register_service(:google_ads, "https://api.google.com/v5") do
   register(:index, :get, "ads")
@@ -66,6 +71,9 @@ end
 
 Now we have a list of endpoints we can stub.
 
+<a id="stubbing-service-endpoints"></a>
+### Stubbing service endpoints
+
 ```ruby
 StubRequests.stub_endpoint(:google_ads, :index)
             .to_return(code: 204, body: "")
@@ -77,8 +85,6 @@ 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)
@@ -93,11 +99,18 @@ WebMock.stub_request(:patch, "#{Settings.google_ads_base_uri}/ads/#{id}")
        .to_return(status: 200, body: response_body.to_json)
 ```
 
-First of all we reduce a lot of duplication.
+This reduces the need to spread out URI's in the test suite without having to resort to shared examples.
 
-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.
+<a id="metrics"></a>
+### Metrics
 
-Madness!!
+Metrics collection are by default turned off. It can be turned on by the following code.
+
+```ruby
+StubRequests.configure do |config|
+  config.record_metrics = true
+end
+```
 
 <a id="future-improvements"></a>
 ## Future Improvements
@@ -111,11 +124,6 @@ sense to make this into an API client. Not sure yet, maybe this will become mult
 Anyway, the idea was to provide endpoint calls in production and stubbed
 requests in tests using the same registry.
 
-<a id="debugging"></a>
-### 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.
-
 <a id="development"></a>
 ## Development
 

data/Rakefile

@@ -12,11 +12,9 @@ YARD::Rake::YardocTask.new do |t|
   t.files   = %w[lib/stub_requests/**/*.rb"]
   t.options = %w[
     --no-private
-    --output-dir docs
-    --readme README.md
-    --output-dir docs
     --markup=markdown
     --markup-provider=redcarpet
+    --readme README.md
   ]
 end
 

data/bin/update_docs.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+git checkout master
+git pull --rebase
+
+rake yard
+
+git checkout gh-pages
+
+shopt -s extglob
+rm -rf "$(echo ./!(bin|_config.yml|_index.html))"
+
+mv doc/* ./
+git commit -a -m 'Update documentation'
+git push
+

data/gemfiles/webmock_2.3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    stub_requests (0.1.0)
+    stub_requests (0.1.1)
       concurrent-ruby (~> 1.0, < 2)
       docile (~> 1.0, < 2)
       public_suffix (~> 3.0, < 4)

data/gemfiles/webmock_3.5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    stub_requests (0.1.0)
+    stub_requests (0.1.1)
       concurrent-ruby (~> 1.0, < 2)
       docile (~> 1.0, < 2)
       public_suffix (~> 3.0, < 4)

data/gemfiles/webmock_develop.gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: ..
   specs:
-    stub_requests (0.1.0)
+    stub_requests (0.1.1)
       concurrent-ruby (~> 1.0, < 2)
       docile (~> 1.0, < 2)
       public_suffix (~> 3.0, < 4)

data/lib/rspec/subject_as_lambda.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+
+module RSpec
+  #
+  # SubjectAsLambda provides a convenient way of turning a regular subject into a proc
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  module SubjectAsLambda
+    # Creates a nested example group named by the submitted `attribute`,
+    # and then generates an example using the submitted block.
+    #
+    # @example
+    #
+    #   # This ...
+    #   describe Array do
+    #     its(:size) { should eq(0) }
+    #   end
+    #
+    #   # ... generates the same runtime structure as this:
+    #   describe Array do
+    #     describe "size" do
+    #       it "should eq(0)" do
+    #         subject.size.should eq(0)
+    #       end
+    #     end
+    #   end
+    #
+    # The attribute can be a `Symbol` or a `String`. Given a `String`
+    # with dots, the result is as though you concatenated that `String`
+    # onto the subject in an expression.
+    #
+    # @example
+    #
+    #   describe Person do
+    #     subject do
+    #       Person.new.tap do |person|
+    #         person.phone_numbers << "555-1212"
+    #       end
+    #     end
+    #
+    #     its("phone_numbers.first") { should eq("555-1212") }
+    #   end
+    #
+    # When the subject is a `Hash`, you can refer to the Hash keys by
+    # specifying a `Symbol` or `String` in an array.
+    #
+    # @example
+    #
+    #   describe "a configuration Hash" do
+    #     subject do
+    #       { :max_users => 3,
+    #         'admin' => :all_permissions.
+    #         'john_doe' => {:permissions => [:read, :write]}}
+    #     end
+    #
+    #     its([:max_users]) { should eq(3) }
+    #     its(['admin']) { should eq(:all_permissions) }
+    #     its(['john_doe', :permissions]) { should eq([:read, :write]) }
+    #
+    #     # You can still access its regular methods this way:
+    #     its(:keys) { should include(:max_users) }
+    #     its(:count) { should eq(2) }
+    #   end
+    #
+    # With an implicit subject, `is_expected` can be used as an alternative
+    # to `should` (e.g. for one-liner use). An `are_expected` alias is also
+    # supplied.
+    #
+    # @example
+    #
+    #   describe Array do
+    #     its(:size) { is_expected.to eq(0) }
+    #   end
+    #
+    # You can pass more than one argument on the `its` block to add
+    # some metadata to the generated example
+    #
+    # @example
+    #
+    #   # This ...
+    #   describe Array do
+    #     its(:size, :focus) { should eq(0) }
+    #   end
+    #
+    #   # ... generates the same runtime structure as this:
+    #   describe Array do
+    #     describe "size" do
+    #       it "should eq(0)", :focus do
+    #         subject.size.should eq(0)
+    #       end
+    #     end
+    #   end
+    #
+    # Note that this method does not modify `subject` in any way, so if you
+    # refer to `subject` in `let` or `before` blocks, you're still
+    # referring to the outer subject.
+    #
+    # @example
+    #
+    #   describe Person do
+    #     subject { Person.new }
+    #     before { subject.age = 25 }
+    #     its(:age) { should eq(25) }
+    #   end
+    # :reek:DuplicateMethodCall
+    # :reek:TooManyStatements
+    def it!(*options, &block)
+      it_lambda_caller = caller.reject { |file_line| file_line =~ %r{/rspec/subject_as_lambda} }
+      describe(nil, caller: it_lambda_caller) do
+        let(:__it_lambda_subject) do
+          subject
+        end
+
+        def is_expected # rubocop:disable Lint/NestedMethodDefinition, Naming/PredicateName
+          expect { __it_lambda_subject }
+        end
+        alias_method :are_expected, :is_expected
+
+        options << {} unless options.last.is_a?(Hash)
+        options.last[:caller] = it_lambda_caller
+
+        example(nil, *options, &block)
+      end
+    end
+
+    alias specify! it!
+  end
+end
+
+RSpec.configure do |rspec|
+  rspec.extend RSpec::SubjectAsLambda
+  rspec.backtrace_exclusion_patterns << %r{/lib/rspec/subject_as_lambda}
+end
+
+RSpec::SharedContext.send(:include, RSpec::SubjectAsLambda)

data/lib/stub_requests/api.rb

@@ -13,11 +13,23 @@ module StubRequests
   # @note This module can either be used by its class methods
   #   or included in say RSpec
   #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  # :reek:DataClump
   module API
     # extends "self"
     # @!parse extend self
     extend self
 
+    # :reek:LongParameterList { max_params: 4 }
+    # @api private
+    def self._stub_endpoint(service_id, endpoint_id, uri_replacements = {}, options = {})
+      _service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, uri_replacements)
+      endpoint_stub           = WebMock::Builder.build(endpoint.verb, uri, options)
+
+      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
+    end
+
     # :nodoc:
     def self.included(base)
       base.send(:extend, self)
@@ -25,49 +37,71 @@ module StubRequests
 
     # 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
     #
+    # @example Register a service with endpoints
+    #   register_service(:documents, "https://company.com/api/v1") do
+    #     register_endpoints do
+    #       register(:show, :get, "documents/:id")
+    #       register(:index, :get, "documents")
+    #       register(:create, :post, "documents")
+    #       register(:update, :patch, "documents/:id")
+    #       register(:destroy, :delete, "documents/:id")
+    #     end
+    #   end
+    #
     # @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 = ServiceRegistry.instance.register(service_id, service_uri)
+      Docile.dsl_eval(service.endpoints, &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>] 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
+    # @option options [optional, TrueClass] :timeout set to true to raise some kind of timeout error
+    #
+    # @note the kind of timeout error raised by webmock is depending on the HTTP client used
     #
     # @example Stub a request to a registered service endpoint
     #   register_stub(
     #     :google_api,
     #     :get_map_location,
+    #     {}, # No URI replacements needed for this endpoint
     #     { request: { headers: { "Accept" => "application/json" }}},
     #     { response: { body: { id: "abyasdjasd", status: "successful" }}}
     #   )
     #
+    # @example Stub a request to a registered service endpoint using block version
+    #   register_stub(:documents, :index) do
+    #     with(headers: { "Accept" => "application/json" }}})
+    #     to_return(body: "No content", status: 204)
+    #   end
+    #
     # @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)
+      service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, uri_replacements)
+      endpoint_stub          = WebMock::Builder.build(endpoint.verb, uri, options, &callback)
 
-      StubRequests::WebMockBuilder.build(endpoint.verb, uri, options, &callback)
+      Metrics.record(service, endpoint, endpoint_stub)
+      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
     end
   end
 end

data/lib/stub_requests/argument_validation.rb

@@ -13,6 +13,8 @@ module StubRequests
   #
   # Module ArgumentValidation provides validation of method arguments
   #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   module ArgumentValidation
     extend self
 
@@ -23,17 +25,26 @@ module StubRequests
     # @param [Object] value the value to validate
     # @param [Array<Class>, Array<Module>, Class, Module] is_a
     #
-    # @raise [InvalidType] when the value is disallowed
+    # @raise [InvalidArgumentType] when the value is disallowed
     #
     # @return [true] when the value is allowed
     #
-    def validate!(value, is_a:)
-      expected_types = Array(is_a)
-      return true if expected_types.any? { |type| value.is_a?(type) }
+    # :reek:UtilityFunction
+    def validate!(name, value, is_a:)
+      validate! :name, name, is_a: [Symbol, String] unless name
+
+      expected_types = Array(is_a).flatten
+      return true if validate(value, expected_types)
 
-      raise StubRequests::InvalidType,
+      raise StubRequests::InvalidArgumentType,
+            name: name,
             actual: value.class,
-            expected: expected_types.join(", ")
+            expected: expected_types
+    end
+
+    # :reek:UtilityFunction
+    def validate(value, expected_types)
+      expected_types.any? { |type| value.is_a?(type) }
     end
   end
 end

data/lib/stub_requests/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Configuration contains gem configuration
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  class Configuration
+    include Property
+
+    property :record_metrics, type: [TrueClass, FalseClass], default: false
+  end
+end

data/lib/stub_requests/core_ext/all.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
+require "stub_requests/core_ext/array/extract_options"
+require "stub_requests/core_ext/kernel/singleton_class"
+require "stub_requests/core_ext/module/redefine_method"
+require "stub_requests/core_ext/class/attribute"
 require "stub_requests/core_ext/object/blank"