stub_requests 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981c31047c2aad42cd7c11962cb1429e742dfda6ed6656485a78d4b83f5acd78
-  data.tar.gz: 49b9c4cfd8fde9f4ab99429fcd5ae02b68809f98d47009b43b880f7802d09202
+  metadata.gz: fb6e6aa72e0616a2a89284efa00ae33420dcf6cf3247e069af90fda69c769733
+  data.tar.gz: f7c963fcc527dce3e5979890b908d9a9a8acd31d676e5a91353180ea8ba55612
 SHA512:
-  metadata.gz: 725506e6bfec1e4088bd8cbe436c33c285a0a0d7e7a9601cb6257d4f9375a321ba3ea663e5bcbf81a3d2dbdb5aac75b265676cbcbec220faaf6856706ec12de4
-  data.tar.gz: eafe65b7a4cec3296935ac42745480a486a1929c5f95a62b8ba9f438317f4ce7d6291724aaece80352e36728193a88cfe782d11651198c349ada37ef560bce7c
+  metadata.gz: d6cc37d6d92dec8aeacee90ff793f12db37deef28a4b735854fd34d6838ac47952a39e75f190e3488613a67fb9e475be952da5a4c9d3ec865bd1ed30cd68f5e2
+  data.tar.gz: 9db50e02b973429d74fa989baa0212d78b1c6df34e5aca7b556573bdf8bdff25aa689a0b21d053b4308fe8faefbb3826f277686d217687b147d9e9f44dbb0232

data/.gitignore

@@ -2,6 +2,7 @@
 /.rspec_status
 /.yardoc
 /_yardoc/
+/gemfiles/*.lock
 /coverage/
 /doc/
 /docs

data/.reek.yml

@@ -1,15 +1,55 @@
 # Auto generated by Reeks --todo flag
 ---
-detectors:
-  ManualDispatch:
-    exclude:
-    - Object#blank?
-  Attribute:
-    exclude:
-    - StubRequests#logger
-
 exclude_paths:
   - vendor/bundle
   - gemfiles
   - lib/stub_requests/core_ext/
   - spec/
+detectors:
+  DuplicateMethodCall:
+    exclude:
+      - RSpec::SubjectAsLambda#it!
+      - StubRequests::CallbackRegistry#find_by
+  TooManyMethods:
+    exclude:
+      - StubRequests::Endpoints
+  TooManyStatements:
+    exclude:
+      - initialize
+      - RSpec::SubjectAsLambda#it!
+  DataClump:
+    exclude:
+      - StubRequests::API
+      - StubRequests::Endpoints
+      - StubRequests::StubRegistry
+  LongParameterList:
+    exclude:
+      - StubRequests::API#register_callback
+      - StubRequests::CallbackRegistry#register
+      - StubRequests::CallbackRegistry#self.register
+      - StubRequests::Property::Validator#self.call
+  UtilityFunction:
+    exclude:
+      - StubRequests::API#define_stubs
+      - StubRequests::API#print_stubs
+      - StubRequests::API#register_callback
+      - StubRequests::API#register_service
+      - StubRequests::API#stub_endpoint
+      - StubRequests::API#unregister_callback
+      - StubRequests::StubRegistry#initialize_endpoint_stub
+  ControlParameter:
+    exclude:
+      - StubRequests::CallbackRegistry#find_by
+      - StubRequests::Property::Validator#initialize
+  FeatureEnvy:
+    exclude:
+      - StubRequests::CallbackRegistry#dispatch_callback
+      - StubRequests::CallbackRegistry#find_by
+      - StubRequests::CallbackRegistry#invoke_callbacks
+      - StubRequests::StubRegistry#find_endpoint_stub
+  Attribute:
+    exclude:
+      - StubRequests#logger
+  TooManyInstanceVariables:
+    exclude:
+      - StubRequests::URI::Builder

data/.rspec

@@ -1,3 +1,4 @@
---format documentation
+--require fuubar
+--format Fuubar
 --color
 --require spec_helper

data/CHANGELOG.md

@@ -2,20 +2,59 @@
 
 ## [Unreleased](https://github.com/mhenrixon/stub_requests/tree/HEAD)
 
-[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.0...HEAD)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.4...HEAD)
+
+**Implemented enhancements:**
+
+- Use fuubar for spec formatting [\#19](https://github.com/mhenrixon/stub_requests/pull/19) ([mhenrixon](https://github.com/mhenrixon))
+- Adds print stub definitions [\#18](https://github.com/mhenrixon/stub_requests/pull/18) ([mhenrixon](https://github.com/mhenrixon))
+
+**Fixed bugs:**
+
+- Fix bug with defining properties [\#17](https://github.com/mhenrixon/stub_requests/pull/17) ([mhenrixon](https://github.com/mhenrixon))
+
+**Merged pull requests:**
+
+- Update Changelog [\#16](https://github.com/mhenrixon/stub_requests/pull/16) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v0.1.4](https://github.com/mhenrixon/stub_requests/tree/v0.1.4) (2019-02-06)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.3...v0.1.4)
+
+**Implemented enhancements:**
+
+- DSL for building stub methods [\#15](https://github.com/mhenrixon/stub_requests/pull/15) ([mhenrixon](https://github.com/mhenrixon))
+
+**Merged pull requests:**
+
+- Update Changelog [\#13](https://github.com/mhenrixon/stub_requests/pull/13) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v0.1.3](https://github.com/mhenrixon/stub_requests/tree/v0.1.3) (2019-02-04)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.2...v0.1.3)
 
 **Implemented enhancements:**
 
 - Add rough initial implementation of subscriptions [\#12](https://github.com/mhenrixon/stub_requests/pull/12) ([mhenrixon](https://github.com/mhenrixon))
+
+**Merged pull requests:**
+
+- Update Changelog [\#11](https://github.com/mhenrixon/stub_requests/pull/11) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v0.1.2](https://github.com/mhenrixon/stub_requests/tree/v0.1.2) (2019-02-03)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.1...v0.1.2)
+
+**Implemented enhancements:**
+
 - Script updating documentation [\#9](https://github.com/mhenrixon/stub_requests/pull/9) ([mhenrixon](https://github.com/mhenrixon))
 - Add a simple script to update documentation [\#8](https://github.com/mhenrixon/stub_requests/pull/8) ([mhenrixon](https://github.com/mhenrixon))
 - Improve documentation [\#7](https://github.com/mhenrixon/stub_requests/pull/7) ([mhenrixon](https://github.com/mhenrixon))
 - Initial metrics implementation [\#6](https://github.com/mhenrixon/stub_requests/pull/6) ([mhenrixon](https://github.com/mhenrixon))
 - Remove the docs folder in preference of a branch [\#5](https://github.com/mhenrixon/stub_requests/pull/5) ([mhenrixon](https://github.com/mhenrixon))
 
+## [v0.1.1](https://github.com/mhenrixon/stub_requests/tree/v0.1.1) (2019-02-01)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.0...v0.1.1)
+
 **Merged pull requests:**
 
-- Update Changelog [\#11](https://github.com/mhenrixon/stub_requests/pull/11) ([mhenrixon](https://github.com/mhenrixon))
 - 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))

data/README.md

@@ -20,7 +20,8 @@ This is achieve by keeping a registry over the service endpoints.
   - [Register service endpoints](#register-service-endpoints)
   - [Stubbing service endpoints](#stubbing-service-endpoints)
   - [Metrics](#metrics)
-  - [Observing endpoint invocations](#observing-endpoint-invocations)
+  - [Endpoint invocation callbacks](#endpoint-invocation-callbacks)
+  - [Using Method Stubs](#using-method-stubs)
 - [Future Improvements](#future-improvements)
   - [API Client Gem](#api-client-gem)
 - [Development](#development)
@@ -68,11 +69,12 @@ The naming of the `service_id` and `endpoint_id`'s is irrelevant. This is just h
 
 ```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")
+  get    "ads",     as: :ads_index
+  get    "ads/:id", as: :ads_show
+  patch  "ads/:id", as: :ads_update
+  put    "ads/:id", as: :ads_update
+  post   "ads",     as: :ads_create
+  delete "ads/:id", as: :ads_destroy
 end
 ```
 
@@ -119,8 +121,8 @@ StubRequests.configure do |config|
 end
 ```
 
-<a id="observing-endpoint-invocations"></a>
-### Observing endpoint invocations
+<a id="endpoint-invocation-callbacks"></a>
+### Endpoint invocation callbacks
 
 ```ruby
 # To jump into pry when a request is called
@@ -131,14 +133,140 @@ end
 
 callback = ->(request) { p request; binding.pry }
 
-StubRequests.register(:document_service, :show, :get, callback)
+StubRequests.register_callback(:document_service, :show, :get, callback)
 ```
 
 ```ruby
 # To unsubscribe from notifications
-StubRequests.unregister(:document_service, :show, :get)
+StubRequests.unregister_callback(:document_service, :show, :get)
 ```
 
+<a id="using-method-stubs"></a>
+### Using Method Stubs
+
+```ruby
+#
+# 1. Register some service endpoints
+#
+StubRequests.register_service(:documents, "https://company.com/api/v1") do
+  get    "documents/:id", as: :documents_show
+  get    "documents",     as: :documents_index
+  post   "documents",     as: :documents_create
+  patch  "documents/:id", as: :documents_update
+  put    "documents/:id", as: :document_put
+  delete "documents/:id"  as: :documents_destroy
+end
+
+#
+# 2. Create a module where the methods should be defined
+#
+module Stubs
+  module Documents
+  end
+end
+
+#
+# 3. Define the stubs for the registered endpoints
+#
+StubRequests::DSL.define_stubs(:documents, Stubs::Documents)
+
+Documents.instance_methods #=>
+ [
+   :stub_documents_show
+   :stub_documents_index
+   :stub_documents_create
+   :stub_documents_update
+   :stub_document_put
+   :stub_documents_destroy
+ ]
+
+#
+# 4. Use the module in our tests
+#
+RSpec.describe ClassThatCallsTheDocumentService do
+  include Stubs::Documents
+
+  let(:document_id) { 123455 }
+  let(:documents_show_body) do
+    {
+      id: document_id,
+      status: "draft",
+    }
+  end
+
+  before do
+    stub_documents_show(id: document_id)
+      .to_return(status: 200, body: documents_show_body.to_json)
+  end
+
+  it "stubs the request nicely" do
+    # execute code that calls the service
+    uri      = URI("https://company.com/api/v1/documents/#{document_id}")
+    response = Net::HTTP.get(uri)
+
+    expect(response).to be_json_eql(example_api_list_task_response.to_json)
+  end
+end
+```
+
+If you prefer to keep a hard copy of the methods in your project then you can print the method definitions to the console and copy paste.
+
+This puts the user in charge of keeping them up to date with the gem.
+
+```ruby
+#
+# 1. Register some service endpoints
+#
+StubRequests.register_service(:documents, "https://company.com/api/v1") do
+  get    "documents/:id", as: :documents_show
+  get    "documents",     as: :documents_index
+  post   "documents",     as: :documents_create
+  patch  "documents/:id", as: :documents_update
+  put    "documents/:id", as: :document_put
+  delete "documents/:id", as: :documents_destroy
+end
+
+#
+# 2. Print the stub definitions to STDOUT
+#
+StubRequests.print_stubs(:documents) #=>
+
+#
+# 3. Copy the stubs into a module
+#
+module DocumentStubs
+  def stub_documents_show(id:, &block)
+    StubRequests.stub_endpoint(:documents, :documents_show, id: id, &block)
+  end
+
+
+  def stub_documents_index(&block)
+    StubRequests.stub_endpoint(:documents, :documents_index, &block)
+  end
+
+
+  def stub_documents_create(&block)
+    StubRequests.stub_endpoint(:documents, :documents_create, &block)
+  end
+
+
+  def stub_documents_update(id:, &block)
+    StubRequests.stub_endpoint(:documents, :documents_update, id: id, &block)
+  end
+
+
+  def stub_document_put(id:, &block)
+    StubRequests.stub_endpoint(:documents, :document_put, id: id, &block)
+  end
+
+
+  def stub_documents_destroy(id:, &block)
+    StubRequests.stub_endpoint(:documents, :documents_destroy, id: id, &block)
+  end
+end
+```
+
+
 <a id="future-improvements"></a>
 ## Future Improvements
 

data/bin/console

@@ -4,12 +4,10 @@
 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__)
+begin
+  require "pry"
+  Pry.start(__FILE__)
+rescue LoadError, NameError
+  require "irb"
+  IRB.start(__FILE__)
+end

data/lib/rspec/subject_as_lambda.rb

@@ -105,8 +105,7 @@ module RSpec
     #     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

data/lib/stub_requests/api.rb

@@ -15,7 +15,6 @@ module StubRequests
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
   #
-  # :reek:DataClump
   module API
     # extends "self"
     # @!parse extend self
@@ -34,22 +33,47 @@ module StubRequests
     #
     # @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
+    #     get    "documents/:id", as: :show
+    #     get    "documents",     as: :index
+    #     post   "documents",     as: :create
+    #     patch  "documents/:id", as: :update
+    #     delete "documents/:id", as: :destroy
     #   end
     #
     # @return [Service] a new service or a previously registered service
     #
-    # :reek:UtilityFunction
     def register_service(service_id, service_uri, &block)
       StubRequests::ServiceRegistry.register_service(service_id, service_uri, &block)
     end
 
+    #
+    # Define stub methods for service in the receiver
+    #
+    #
+    # @see DSL#define_stubs
+    #
+    # @param [Symbol] service_id the id of a registered service
+    # @param [Module] receiver the receiver of the stub methods
+    #
+    # @return [void] outputs a list of methods to the console
+    #
+    def define_stubs(service_id, receiver:)
+      DSL.new(service_id, receiver: receiver).define_stubs
+    end
+
+    #
+    # Print stub method definitions to manually add to a module or class
+    #
+    # @see DSL#print_stubs
+    #
+    # @param [Symbol] service_id the id of a registered service
+    #
+    # @return [void] prints to STDOUT
+    #
+    def print_stubs(service_id)
+      DSL.new(service_id).print_stubs
+    end
+
     #
     # Stub a request to a registered service endpoint
     #
@@ -61,7 +85,7 @@ module StubRequests
     # @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 using block version
-    #   register_stub(:documents, :index) do
+    #   stub_endpoint(:documents, :index) do
     #     with(headers: { "Accept" => "application/json" }}})
     #     to_return(body: "No content", status: 204)
     #   end
@@ -69,8 +93,6 @@ module StubRequests
     # @see #stub_http_request
     # @return [WebMock::RequestStub] a mocked request
     #
-    # :reek:UtilityFunction
-    # :reek:LongParameterList { max_params: 5 }
     def stub_endpoint(service_id, endpoint_id, route_params = {}, &callback)
       StubRequests::ServiceRegistry.stub_endpoint(service_id, endpoint_id, route_params, &callback)
     end
@@ -85,8 +107,6 @@ module StubRequests
     #
     # @return [void]
     #
-    # :reek:UtilityFunction
-    # :reek:LongParameterList
     def register_callback(service_id, endpoint_id, verb, callback)
       StubRequests::CallbackRegistry.register(service_id, endpoint_id, verb, callback)
     end
@@ -99,7 +119,6 @@ module StubRequests
     #
     # @return [void]
     #
-    # :reek:UtilityFunction
     def unregister_callback(service_id, endpoint_id, verb)
       StubRequests::CallbackRegistry.unregister(service_id, endpoint_id, verb)
     end

data/lib/stub_requests/argument_validation.rb

@@ -30,13 +30,11 @@ module StubRequests
     #
     # @return [void]
     #
-    # :reek:UtilityFunction
     def validate!(name:, value:, type:)
       validate_type!(:name, name, [Symbol, String]) unless name
       validate_type!(name, value, type) if type
     end
 
-    # :reek:UtilityFunction
     def validate_type!(name, value, type)
       expected_types = Array(type).flatten
       return if expected_types.any? { |is_a| value.is_a?(is_a) }

data/lib/stub_requests/callback.rb

@@ -47,8 +47,15 @@ module StubRequests
       self.callback    = callback
     end
 
-    def call(*args)
-      callback.call(*args)
+    def call(request_stub)
+      case arity
+      when 0
+        callback.call
+      when 1
+        callback.call(request_stub)
+      else
+        raise InvalidCallback, "The callback for a callback can either take 0 or 1 arguments (was #{arity})"
+      end
     end
 
     def arity

data/lib/stub_requests/callback_registry.rb

@@ -13,9 +13,6 @@ module StubRequests
   # @author Mikael Henriksson <mikael@zoolutions.se>
   # @since 0.1.3
   #
-  # :reek:UtilityFunction
-  # :reek:DataClump
-  # :reek:FeatureEnvy
   class CallbackRegistry
     include Singleton
     include Enumerable
@@ -32,7 +29,6 @@ module StubRequests
     #
     # @return [Callback]
     #
-    # :reek:LongParameterList
     def self.register(service_id, endpoint_id, verb, callback)
       instance.register(service_id, endpoint_id, verb, callback)
     end
@@ -110,7 +106,6 @@ module StubRequests
     #
     # @return [Callback] the added callback
     #
-    # :reek:LongParameterList
     def register(service_id, endpoint_id, verb, block)
       callback = find_by(service_id, endpoint_id, verb)
       return callback if callback
@@ -130,7 +125,6 @@ module StubRequests
     #
     # @return [Callback] the deleted callback
     #
-    # :reek:ControlParameter
     def unregister(service_id, endpoint_id, verb)
       return unless (callback = find_by(service_id, endpoint_id, verb))
 
@@ -140,14 +134,14 @@ module StubRequests
     #
     # Notifies subscribers that a request was made
     #
-    # @param [RequestStub] request the stubbed request
+    # @param [RequestStub] request_stub the stubbed request
     #
     # @return [void]
     #
-    def invoke_callbacks(request)
-      return unless (callback = find_by(request.service_id, request.endpoint_id, request.verb))
+    def invoke_callbacks(request_stub)
+      return unless (callback = find_by(request_stub.service_id, request_stub.endpoint_id, request_stub.verb))
 
-      dispatch_callback(request, callback)
+      callback.call(request_stub)
     end
 
     private
@@ -162,8 +156,6 @@ module StubRequests
     #
     # @return [Callback]
     #
-    # :reek:ControlParameter
-    # :reek:DuplicateMethodCall
     def find_by(service_id, endpoint_id, verb)
       find do |sub|
         sub.service_id == service_id &&
@@ -171,18 +163,5 @@ module StubRequests
           ([sub.verb, verb].include?(:any) || sub.verb == verb)
       end
     end
-
-    def dispatch_callback(request_stub, callback)
-      arity = callback.arity
-
-      case arity
-      when 0
-        callback.call
-      when 1
-        callback.call(request_stub)
-      else
-        raise InvalidCallback, "The callback for a callback can either take 0 or 1 arguments (was #{arity})"
-      end
-    end
   end
 end

data/lib/stub_requests/dsl/method_definition.rb

@@ -52,7 +52,7 @@ module StubRequests
       def to_s
         <<~METHOD
           def #{name}(#{keywords})
-            stub_endpoint(:#{service_id}, :#{endpoint_id}, #{arguments})
+            StubRequests.stub_endpoint(:#{service_id}, :#{endpoint_id}, #{arguments})
           end
         METHOD
       end

data/lib/stub_requests/dsl.rb

@@ -10,9 +10,9 @@ module StubRequests
   # @example **Register service with endpoints**
   #   StubRequests.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")
+  #       get "documents/:id", as: :documents_show
+  #       get "documents",     as: :documents_index
+  #       post "documents",    as: :documents_create
   #     end
   #   end
   # @example **Create a receiver module for the stub methods**
@@ -20,7 +20,7 @@ module StubRequests
   #
   #   Stubs.instance_methods #=> []
   # @example **Define the endpoint methods using the DSL**
-  #   StubRequests::DSL.define_endpoint_methods(
+  #   StubRequests::DSL.define_stubs(
   #     :documents, receiver: Stubs
   #   )
   #
@@ -28,17 +28,17 @@ module StubRequests
   #
   #   Stubs.instance_methods #=> [:stub_documents_show, :stub_documents_index, :stub_documents_create]
   #   module Stubs
-  #      def stub_documents_show(id:, &block)
-  #         stub_endpoint(:documents, :show, id: id, &block)
-  #      end
+  #     def stub_documents_show(id:, &block)
+  #        stub_endpoint(:documents, :show, id: id, &block)
+  #     end
   #
-  #      def stub_documents_index(&block)
-  #         stub_endpoint(:documents, :index, &block)
-  #      end
+  #     def stub_documents_index(&block)
+  #        stub_endpoint(:documents, :index, &block)
+  #     end
   #
-  #      def stub_documents_create(&block)
-  #         stub_endpoint(:documents, :create, &block)
-  #      end
+  #     def stub_documents_create(&block)
+  #        stub_endpoint(:documents, :create, &block)
+  #     end
   #    end
   #
   # @example **Use the helper methods in your tests**
@@ -70,24 +70,60 @@ module StubRequests
   #     expect(response).to be_json_eql(response_body.to_json)
   #   end
   class DSL
-    def self.define_endpoint_methods(service_id, receiver:)
-      new(service_id, receiver: receiver).define_endpoint_methods
-    end
-
-    attr_reader :service, :receiver, :endpoints
+    #
+    # @!attribute [r] service
+    #   @return [Service] an instance of a service
+    attr_reader :service
+    #
+    # @!attribute [r] receiver
+    #   @return [Module, nil] the receiver module
+    attr_reader :receiver
+    #
+    # @!attribute [r] endpoints
+    #   @return [Array<Endpoint>] a collection of endpoints
+    attr_reader :endpoints
 
-    def initialize(service_id, receiver:)
-      @service   = StubRequests::ServiceRegistry.instance.find(service_id)
+    #
+    # Initialize a new instance of DSL
+    #
+    # @param [Symbol] service_id the id of a registered service
+    # @param [Module] receiver the receiver of the stub methods
+    #
+    def initialize(service_id, receiver: nil)
+      @service   = StubRequests::ServiceRegistry.instance.find!(service_id)
       @receiver  = receiver
       @endpoints = service.endpoints.endpoints.values
     end
 
-    def define_endpoint_methods
+    #
+    # Defines stub methods for #endpoints in the #receiver
+    #
+    #
+    # @return [void]
+    #
+    def define_stubs
       receiver.send(:include, StubRequests::API)
 
-      endpoints.each do |endpoint|
-        definition = MethodDefinition.new(service.id, endpoint.id, endpoint.route_params)
-        DefineMethod.new(definition, receiver).define
+      method_definitions.each do |method_definition|
+        DefineMethod.new(method_definition, receiver).define
+      end
+    end
+
+    #
+    # Prints stub methods for #endpoints to STDOUT
+    #
+    #
+    # @return [void]
+    #
+    def print_stubs
+      method_definitions.each do |method_definition|
+        puts("#{method_definition}\n\n")
+      end
+    end
+
+    def method_definitions
+      @method_definitions ||= endpoints.map do |endpoint|
+        MethodDefinition.new(service.id, endpoint.id, endpoint.route_params)
       end
     end
   end

data/lib/stub_requests/endpoints.rb

@@ -49,7 +49,6 @@ module StubRequests
     #
     # @return [Endpoint]
     #
-    # :reek:LongParameterList { max_params: 4 }
     def register(endpoint_id, verb, path)
       endpoint =
         if (endpoint = find(endpoint_id))
@@ -63,9 +62,106 @@ module StubRequests
       endpoint
     end
 
+    #
+    # Convenience wrapper for register
+    #
+    #
+    # @example **Register a get endpoint**
+    # .  get("documents/:id", as: :documents_show)
+    #
+    # @param [String] path the path to the endpoint
+    # @param [Symbol] as the id of the endpoint
+    #
+    # @return [Endpoint] the registered endpoint
+    #
+    def any(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+      register(as, __method__, path)
+    end
+
+    #
+    # Convenience wrapper for register
+    #
+    #
+    # @example **Register a get endpoint**
+    # .  get("documents/:id", as: :documents_show)
+    #
+    # @param [String] path the path to the endpoint
+    # @param [Symbol] as the id of the endpoint
+    #
+    # @return [Endpoint] the registered endpoint
+    #
+    def get(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+      register(as, __method__, path)
+    end
+
+    #
+    # Register a :post endpoint
+    #
+    #
+    # @example **Register a post endpoint**
+    # .  post("documents", as: :documents_create)
+    #
+    # @param [String] path the path to the endpoint
+    # @param [Symbol] as the id of the endpoint
+    #
+    # @return [Endpoint] the registered endpoint
+    #
+    def post(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+      register(as, __method__, path)
+    end
+
+    #
+    # Register a :patch endpoint
+    #
+    #
+    # @example **Register a patch endpoint**
+    # .  patch("documents/:id", as: :documents_update)
+    #
+    # @param [String] path the path to the endpoint
+    # @param [Symbol] as the id of the endpoint
+    #
+    # @return [Endpoint] the registered endpoint
+    #
+    def patch(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+      register(as, __method__, path)
+    end
+
+    #
+    # Register a :put endpoint
+    #
+    #
+    # @example **Register a put endpoint**
+    # .  put("documents/:id", as: :documents_update)
+    #
+    # @param [String] path the path to the endpoint
+    # @param [Symbol] as the id of the endpoint
+    #
+    # @return [Endpoint] the registered endpoint
+    #
+    def put(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+      register(as, __method__, path)
+    end
+
+    #
+    # Register a :delete endpoint
+    #
+    #
+    # @example **Register a delete endpoint**
+    # .  delete("documents/:id", as: :documents_destroy)
+    #
+    # @param [String] path the path to the endpoint
+    # @param [Symbol] as the id of the endpoint
+    #
+    # @return [Endpoint] the registered endpoint
+    #
+    def delete(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+      register(as, __method__, path)
+    end
+
     #
     # Updates an endpoint
     #
+    #
     # @param [Symbol] endpoint_id the id of the endpoint
     # @param [Symbol] verb a HTTP verb
     # @param [String] path the path to the endpoint
@@ -74,7 +170,6 @@ module StubRequests
     #
     # @return [Endpoint] returns the updated endpoint
     #
-    # :reek:LongParameterList { max_params: 4 }
     def update(endpoint_id, verb, path)
       endpoint = find!(endpoint_id)
       endpoint.update(verb, path)
@@ -83,6 +178,7 @@ module StubRequests
     #
     # Removes an endpoint from the collection
     #
+    #
     # @param [Symbol] endpoint_id the id of the endpoint, `:file_service`
     #
     # @return [Endpoint] the endpoint that was removed
@@ -94,6 +190,7 @@ module StubRequests
     #
     # Fetches an endpoint from the collection
     #
+    #
     # @param [<type>] endpoint_id <description>
     #
     # @return [Endpoint]
@@ -105,6 +202,7 @@ module StubRequests
     #
     # Fetches an endpoint from the collection or raises an error
     #
+    #
     # @param [Symbol] endpoint_id the id of the endpoint
     #
     # @raise [EndpointNotFound] when an endpoint couldn't be found
@@ -118,6 +216,7 @@ module StubRequests
     #
     # Returns a descriptive string with all endpoints in the collection
     #
+    #
     # @return [String]
     #
     def to_s

data/lib/stub_requests/property/validator.rb

@@ -38,7 +38,6 @@ module StubRequests
       #
       # @return [void]
       #
-      # :reek:LongParameterList
       def self.call(name, type, default, properties)
         new(name, type, default, properties).run_validations
       end
@@ -67,12 +66,11 @@ module StubRequests
       # @param [Object] default the default value of the property
       # @param [Hash] properties the list of currently defined properties
       #
-      # :reek:LongParameterList
       def initialize(name, type, default = nil, properties = {})
         @type       = Array(type).flatten
         @default    = default
         @name       = name
-        @properties = properties
+        @properties = properties || {}
       end
 
       #
@@ -127,6 +125,7 @@ module StubRequests
       # @return [void]
       #
       def validate_undefined
+        return unless properties
         return unless (prop = properties[name])
 
         raise PropertyDefined, name: name, type: prop[:type], default: prop[:default]

data/lib/stub_requests/property.rb

@@ -33,7 +33,6 @@ module StubRequests
     #
     # @author Mikael Henriksson <mikael@zoolutions.se>
     #
-    # :reek:DataClump
     module ClassMethods
       #
       # Define property methods for the name
@@ -43,7 +42,7 @@ module StubRequests
       # @param [Hash<Symbol>] options a hash with options
       # @option options [Object] :default a default value for the property
       #
-      # @return [Object] the whatever
+      # @return [void]
       #
       def property(name, type:, **options)
         type = normalize_type(type, options)
@@ -65,18 +64,21 @@ module StubRequests
 
       # @api private
       def define_property(name, type, default)
-        property_reader(name)
+        property_reader(name, default)
         property_predicate(name)
         property_writer(name, type)
 
+        set_property_default(name, default)
         set_property_defined(name, type, default)
       end
 
       # @api private
-      def property_reader(name)
+      def property_reader(name, default)
+        invar = "@#{name}"
         silence_redefinition_of_method(name.to_s)
         redefine_method(name) do
-          instance_variable_get("@#{name}") || properties.dig(name, :default)
+          instance_variable_set(invar, default) unless instance_variable_defined?(invar)
+          instance_variable_get(invar)
         end
       end
 
@@ -96,8 +98,13 @@ module StubRequests
         end
       end
 
+      def set_property_default(name, default)
+        instance_variable_set("@#{name}", default)
+      end
+
       # @api private
       def set_property_defined(name, type, default)
+        self.properties ||= {}
         properties[name] = { type: type, default: default }
       end
     end

data/lib/stub_requests/request_stub.rb

@@ -13,7 +13,6 @@ module StubRequests
   # @author Mikael Henriksson <mikael@zoolutions.se>
   # @since 0.1.2
   #
-  # :reek:TooManyInstanceVariables
   class RequestStub
     include Property
     extend Forwardable

data/lib/stub_requests/service_registry.rb

@@ -24,11 +24,11 @@ module StubRequests
     #
     # @example Register a service with endpoints
     #   register_service(:documents, "https://company.com/api/v1") do
-    #     register(:show, :get, "documents/:id")
-    #     register(:index, :get, "documents")
-    #     register(:create, :post, "documents")
-    #     register(:update, :patch, "documents/:id")
-    #     register(:destroy, :delete, "documents/:id")
+    #     get    "documents/:id", as: :show
+    #     get    "documents",     as: :index
+    #     post   "documents",     as: :create
+    #     patch  "documents/:id", as: :update
+    #     delete "documents/:id", as: :destroy
     #   end
     #
     # @return [Service] a new service or a previously registered service
@@ -50,35 +50,27 @@ module StubRequests
     # @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
-    #   )
-    #   .to_return(body: "No content", status: 204)
+    #   stub_endpoint(:google_api, :get_map_location)
+    #    .to_return(body: "No content", status: 204)
     #
     # @example Stub a request to a registered service endpoint using block
-    #   register_stub(:documents, :index) do
+    #   stub_endpoint(: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 self.stub_endpoint(service_id, endpoint_id, route_params = {}, &callback)
       service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, route_params)
-      endpoint_stub          = WebMock::Builder.build(endpoint.verb, uri, {}, &callback)
+      webmock_stub           = WebMock::Builder.build(endpoint.verb, uri, {}, &callback)
 
-      StubRegistry.record(service, endpoint, endpoint_stub)
-      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
+      StubRegistry.record(service, endpoint, webmock_stub)
+      ::WebMock::StubRegistry.instance.register_request_stub(webmock_stub)
     end
 
     # @api private
     # Used only for testing purposes
-    # :reek:LongParameterList { max_params: 4 }
     def self.__stub_endpoint(service_id, endpoint_id, route_params = {})
       _service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, route_params)
       endpoint_stub           = WebMock::Builder.build(endpoint.verb, uri)

data/lib/stub_requests/stub_registry.rb

@@ -14,7 +14,6 @@ module StubRequests
   # @author Mikael Henriksson <mikael@zoolutions.se>
   # @since 0.1.2
   #
-  # :reek:DataClump
   class StubRegistry
     # includes "Singleton"
     # @!parse include Singleton
@@ -145,13 +144,10 @@ module StubRequests
       find_endpoint_stub(service, endpoint) || initialize_endpoint_stub(service, endpoint)
     end
 
-    # :reek:UtilityFunction
-    # :reek:FeatureEnvy
     def find_endpoint_stub(service, endpoint)
       find { |ep| ep.service_id == service.id && ep.endpoint_id == endpoint.id }
     end
 
-    # :reek:UtilityFunction
     def initialize_endpoint_stub(service, endpoint)
       EndpointStub.new(service, endpoint)
     end

data/lib/stub_requests/uri/builder.rb

@@ -18,7 +18,6 @@ module StubRequests
     #
     # @author Mikael Henriksson <mikael@zoolutions.se>
     #
-    # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
     class Builder
       #
       # @return [Regexp] A pattern for matching url segment keys

data/lib/stub_requests/version.rb

@@ -9,5 +9,5 @@
 module StubRequests
   #
   # @return [String] a version string
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/stub_requests.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   # ===== Testing =====
   spec.add_development_dependency "appraisal",      ">= 2.2.0"
   spec.add_development_dependency "json_spec",      ">= 1.1.5"
+  spec.add_development_dependency "fuubar",         ">= 2.3"
   spec.add_development_dependency "rspec",          ">= 3.8"
   spec.add_development_dependency "rspec-its",      ">= 1.2"
   spec.add_development_dependency "rubocop",        "~> 0.63.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stub_requests
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -146,6 +146,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement