stub_requests 0.1.2 → 0.1.3

data/lib/stub_requests/registration/service.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Registration provides registration of stubbed endpoints and services
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.3
+  #
+  module Registration
+    #
+    # Class Service provides details for a registered service
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
+    class Service
+      include Comparable
+      include Property
+
+      # @!attribute [rw] id
+      #   @return [Symbol] the id of the service
+      property :id, type: Symbol
+
+      # @!attribute [rw] uri
+      #   @return [String] the base uri to the service
+      property :uri, type: String
+
+      # @!attribute [rw] endpoints
+      #   @return [Endpoints] a list with defined endpoints
+      attr_reader :endpoints
+
+      #
+      # Initializes a new instance of a Service
+      #
+      # @param [Symbol] service_id the id of this service
+      # @param [String] service_uri the base uri to reach the service
+      #
+      def initialize(service_id, service_uri)
+        self.id    = service_id
+        self.uri   = service_uri
+        @endpoints = Endpoints.new
+      end
+
+      #
+      # Check if the endpoint registry has endpoints
+      #
+      # @return [true,false]
+      #
+      def endpoints?
+        endpoints.any?
+      end
+
+      #
+      # Returns a nicely formatted string with this service
+      #
+      # @return [String]
+      #
+      def to_s
+        [
+          +"#<#{self.class}",
+          +" id=#{id}",
+          +" uri=#{uri}",
+          +" endpoints=#{endpoints.endpoints_string}",
+          +">",
+        ].join("")
+      end
+
+      def <=>(other)
+        id <=> other.id
+      end
+
+      def hash
+        [id, self.class].hash
+      end
+
+      alias eql? ==
+    end
+  end
+end

data/lib/stub_requests/uri.rb

@@ -24,7 +24,7 @@ module StubRequests
     # @return [Array<Service, Endpoint, String] the service, endpoint and full URI
     #
     def self.for_service_endpoint(service_id, endpoint_id, replacements)
-      service  = ServiceRegistry.instance.find!(service_id)
+      service  = Registration::Registry.instance.find!(service_id)
       endpoint = service.endpoints.find!(endpoint_id)
       uri      = URI::Builder.build(service.uri, endpoint.uri_template, replacements)
 

data/lib/stub_requests/version.rb

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

data/lib/tasks/changelog.rake

@@ -3,7 +3,7 @@
 desc "Generate a Changelog"
 task :changelog do
   # rubocop:disable Style/MutableConstant
-  CHANGELOG_COMMAND ||= %w[
+  CHANGELOG_CMD ||= %w[
     github_changelog_generator
     -u
     mhenrixon
@@ -12,7 +12,16 @@ task :changelog do
     --no-verbose
     --token
   ]
+  CHECKOUT_CHANGELOG_CMD ||= "git checkout -B update-changelog"
+  COMMIT_CHANGELOG_CMD   ||= "git add --all"
+  COMMIT_CHANGELOG_CMD   ||= "git commit -a -m 'Update changelog'"
+  GIT_PUSH_CMD           ||= "git push -u origin update-changelog"
+  OPEN_PR_CMD            ||= "hub pull-request -b master  -m 'Update Changelog' -a mhenrixon -l changelog"
   # rubocop:enable Style/MutableConstant
 
-  sh(*CHANGELOG_COMMAND.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
+  sh(*CHANGELOG_CMD.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
+  sh(CHECKOUT_CHANGELOG_CMD)
+  sh(COMMIT_CHANGELOG_CMD)
+  sh(GIT_PUSH_CMD)
+  sh(OPEN_PR_CMD)
 end

data/update_docs.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+git checkout master
+git fetch
+stash_created=0
+
+if [[ "$(git diff --stat)" != "" ]]; then
+  stash_created=1
+  git stash push -u -a -m "Before updating docs"
+fi;
+
+git reset --hard origin/master
+
+rake yard
+
+git checkout gh-pages
+
+echo "Cleaning up current documentation"
+find . ! -path '*/.git*' ! -path '*/doc*' ! -path '*/update_docs.sh*' ! -path '*/_config.yml*' ! -path '*/_index.html*' ! -path '.' | xargs rm -rf
+
+echo "Copying new documentation"
+mv doc/* ./
+
+echo "Sending new documentation to github"
+git add --all
+git commit -a -m 'Update documentation'
+git push
+
+if [[ $stash_created == 1 ]]; then
+  git stash pop
+fi;
+
+git checkout master

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stub_requests
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -370,7 +370,6 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
-- bin/update_docs.sh
 - gemfiles/.bundle/config
 - gemfiles/webmock_2.3.gemfile
 - gemfiles/webmock_2.3.gemfile.lock
@@ -392,17 +391,22 @@ files:
 - lib/stub_requests/core_ext/module/redefine_method.rb
 - lib/stub_requests/core_ext/object/blank.rb
 - lib/stub_requests/endpoint.rb
-- lib/stub_requests/endpoint_registry.rb
 - lib/stub_requests/exceptions.rb
 - lib/stub_requests/hash_util.rb
 - lib/stub_requests/metrics.rb
-- lib/stub_requests/metrics/endpoint_stat.rb
+- lib/stub_requests/metrics/endpoint.rb
 - lib/stub_requests/metrics/registry.rb
-- lib/stub_requests/metrics/stub_stat.rb
+- lib/stub_requests/metrics/request.rb
+- lib/stub_requests/observable.rb
+- lib/stub_requests/observable/registry.rb
+- lib/stub_requests/observable/subscription.rb
 - lib/stub_requests/property.rb
 - lib/stub_requests/property/validator.rb
-- lib/stub_requests/service.rb
-- lib/stub_requests/service_registry.rb
+- lib/stub_requests/registration.rb
+- lib/stub_requests/registration/endpoint.rb
+- lib/stub_requests/registration/endpoints.rb
+- lib/stub_requests/registration/registry.rb
+- lib/stub_requests/registration/service.rb
 - lib/stub_requests/stub_requests.rb
 - lib/stub_requests/uri.rb
 - lib/stub_requests/uri/builder.rb
@@ -416,6 +420,7 @@ files:
 - lib/tasks/gem.rake
 - lib/tasks/git.rake
 - stub_requests.gemspec
+- update_docs.sh
 homepage: https://mhenrixon.github.io/stub_requests/
 licenses:
 - MIT

data/bin/update_docs.sh

@@ -1,16 +0,0 @@
-#!/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/lib/stub_requests/endpoint_registry.rb

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Class EndpointRegistry holds a collection of {Endpoint}
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  #
-  class EndpointRegistry
-    include Enumerable
-
-    #
-    # @!attribute [rw] endpoints
-    #   @return [Concurrent::Map<Symbol, Endpoint>] a map with endpoints
-    attr_reader :endpoints
-
-    def initialize
-      @endpoints = Concurrent::Map.new
-    end
-
-    #
-    # Required by Enumerable
-    #
-    # @return [Concurrent::Map<Symbol, Service>] a map with endpoints
-    #
-    # @yield used by Enumerable
-    #
-    def each(&block)
-      endpoints.each(&block)
-    end
-
-    #
-    # Registers an endpoint in the collection
-    #
-    # @param [Symbol] endpoint_id the id of this Endpoint
-    # @param [Symbol] verb a HTTP verb
-    # @param [String] uri_template the URI to reach the endpoint
-    # @param [optional, Hash<Symbol>] options default options
-    #
-    # @return [Endpoint]
-    #
-    # :reek:LongParameterList { max_params: 4 }
-    def register(endpoint_id, verb, uri_template, options = {})
-      endpoint =
-        if (endpoint = find(endpoint_id))
-          StubRequests.logger.warn("Endpoint already registered: #{endpoint}")
-          endpoint.update(verb, uri_template, options)
-        else
-          Endpoint.new(endpoint_id, verb, uri_template, options)
-        end
-
-      endpoints[endpoint.id] = endpoint
-      endpoint
-    end
-
-    #
-    # Check if an endpoint is registered
-    #
-    # @param [Symbol] endpoint_id the id of the endpoint
-    #
-    # @return [true, false]
-    #
-    def registered?(endpoint_id)
-      endpoints[endpoint_id].present?
-    end
-
-    #
-    # Updates an endpoint
-    #
-    # @param [Symbol] endpoint_id the id of the endpoint
-    # @param [Symbol] verb a HTTP verb
-    # @param [String] uri_template how to reach the endpoint
-    # @param [optional, Hash<Symbol>] options
-    # @option options [optional, Hash<Symbol>] :request request options
-    # @option options [optional, Hash<Symbol>] :response options
-    # @option options [optional, Array, Exception, StandardError, String] :error to raise
-    # @option options [optional, TrueClass] :timeout raise a timeout error?
-    #
-    # @raise [EndpointNotFound] when the endpoint couldn't be found
-    #
-    # @return [Endpoint] returns the updated endpoint
-    #
-    # :reek:LongParameterList { max_params: 4 }
-    def update(endpoint_id, verb, uri_template, options)
-      endpoint = find!(endpoint_id)
-      endpoint.update(verb, uri_template, options)
-    end
-
-    #
-    # Removes an endpoint from the collection
-    #
-    # @param [Symbol] endpoint_id the id of the endpoint, `:file_service`
-    #
-    # @return [Endpoint] the endpoint that was removed
-    #
-    def remove(endpoint_id)
-      endpoints.delete(endpoint_id)
-    end
-
-    #
-    # Fetches an endpoint from the collection
-    #
-    # @param [<type>] endpoint_id <description>
-    #
-    # @return [Endpoint]
-    #
-    def find(endpoint_id)
-      endpoints[endpoint_id]
-    end
-
-    #
-    # 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
-    #
-    # @return [Endpoint, nil]
-    #
-    def find!(endpoint_id)
-      find(endpoint_id) || raise(EndpointNotFound, "Couldn't find an endpoint with id=:#{endpoint_id}")
-    end
-
-    #
-    # Returns a descriptive string with all endpoints in the collection
-    #
-    # @return [String]
-    #
-    def to_s
-      [
-        +"#<#{self.class} endpoints=",
-        +endpoints_string,
-        +">",
-      ].join("")
-    end
-
-    #
-    # Returns a nicely formatted string with an array of endpoints
-    #
-    #
-    # @return [<type>] <description>
-    #
-    def endpoints_string
-      "[#{endpoints_as_string}]"
-    end
-
-    private
-
-    def endpoints_as_string
-      endpoints.values.map(&:to_s).join(",") if endpoints.size.positive?
-    end
-  end
-end

data/lib/stub_requests/service.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Class Service provides details for a registered service
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  #
-  class Service
-    include Comparable
-    include Property
-
-    # @!attribute [rw] id
-    #   @return [EndpointRegistry] the id of the service
-    property :id, type: Symbol
-
-    # @!attribute [rw] uri
-    #   @return [EndpointRegistry] the base uri to the service
-    property :uri, type: String
-
-    # @!attribute [rw] endpoints
-    #   @return [EndpointRegistry] a list with defined endpoints
-    attr_reader :endpoints
-
-    #
-    # Initializes a new instance of a Service
-    #
-    # @param [Symbol] service_id the id of this service
-    # @param [String] service_uri the base uri to reach the service
-    #
-    def initialize(service_id, service_uri)
-      self.id    = service_id
-      self.uri   = service_uri
-      @endpoints = EndpointRegistry.new
-    end
-
-    #
-    # Check if the endpoint registry has endpoints
-    #
-    # @return [true,false]
-    #
-    def endpoints?
-      endpoints.any?
-    end
-
-    #
-    # Returns a nicely formatted string with this service
-    #
-    # @return [String]
-    #
-    def to_s
-      [
-        +"#<#{self.class}",
-        +" id=#{id}",
-        +" uri=#{uri}",
-        +" endpoints=#{endpoints.endpoints_string}",
-        +">",
-      ].join("")
-    end
-
-    def <=>(other)
-      id <=> other.id
-    end
-
-    def hash
-      [id, self.class].hash
-    end
-
-    alias eql? ==
-  end
-end