endpoint_stub 1.1.0 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b16dff51967c4be2433bd1743c9fcd182775613e
-  data.tar.gz: f2b80f0274615d21885838acf3ce83a7b5e405d9
+  metadata.gz: d478a91265f34ca548261653054f9c7f80dfd5b5
+  data.tar.gz: a7302ecb8415182aee62cb945c44118a5fe25463
 SHA512:
-  metadata.gz: 3f1f45d0961b3c4ad738d76789b5a49a8ef3170f0f64f390a07f139dd14035c85231d2599d063127941999b17013f4f903e6dcb6a144939285421739d4f04a94
-  data.tar.gz: ac4bf26b1026758711958739f75bbdcbb984454e63fdb32f8c1e7cf0829530bb7f4ec10d8aceaa667a73dbbc89d2158f4910fe5fae87a80993cf4670c33dfaa0
+  metadata.gz: f67ed8b7eae33b91bb8264c9cef4ca8dd3e061bbf3668c02d7f931003e8ac36ae68e706e7ee5795af6346c50dd438d71666138ae4d02852293abe56a32d53fab
+  data.tar.gz: ef2b62184775a3d52f0efda1db83df8b17f37b3237ac54a1ab133c4092778c0a7c6c284208bda6910b1a2dde663ecaeb30f212e1a3e4c2b5955df909f38cf9cd

data/README.md

@@ -6,7 +6,7 @@ outdated, so I decided to make my own using WebMock.
 EndpointStub is kind of like the built in ActiveResource HTTPMock, except
 you can bind logic and dynamic routes to it, so it's like a mini controller
 almost. EndpointStub comes with the default RESTful CRUD actions supported
-by ActiveResource build in (currently JSON format only). It also comes with
+by ActiveResource built in (currently JSON format only). It also comes with
 an interface for defining your own routes and logic.
 
 Nested resources are currently pending, but definitely implementable via custom
@@ -16,6 +16,7 @@ response mocking.
 
 Add this line to your application's Gemfile:
 
+    gem 'webmock'
     gem 'endpoint_stub'
 
 And then execute:

data/lib/endpoint/response.rb

@@ -0,0 +1,148 @@
+require 'webmock'
+
+class Response
+  include WebMock::API
+
+  # For remembering where a uri-based parameter is located.
+  ParamIndices = Struct.new(:slash, :dot)
+  # Allows more comfortable use of Symbol keys when accessing
+  # params (which are string keys).
+  class Params < Hash
+    def [](key)
+      super(key.to_s)
+    end
+    def []=(key, value)
+      super(key.to_s, value)
+    end
+  end
+
+  def initialize(type, url, stub, &proc)
+    @param_indices = {}
+    
+    @url_regex = build_url_regex!(url)
+
+    @type = type
+    @stub = stub
+
+    @response_stack = [proc]
+  end
+
+  def activated?
+    !@stubbed_request.nil?
+  end
+
+  # This should add the stubbed request to WebMock.
+  def activate!
+    @stubbed_request = stub_request(@type, @url_regex).
+      to_return(&create_response_proc(@response_stack))
+  end
+
+  # This should remove the request stubbed by #activate!
+  # Passing a block will reactivate when done with block logic
+  # if previously activated.
+  def deactivate!
+    remove_request_stub @stubbed_request
+    if block_given?
+      yield
+      activate! if @stubbed_request
+    else
+      @stubbed_request = nil
+    end
+  end
+
+  def reset!
+    deactivate!
+    activate!
+  end
+
+  def add_to_stack(&proc)
+    deactivate! do
+      @response_stack << proc
+    end
+  end
+
+  # Return to the first stubbed response.
+  def drop_overrides!
+    deactivate! do
+      remove_request_stub @stubbed_request
+      @response_stack = @response_stack[0..1]
+    end
+  end
+
+  private
+
+  # Creates a proc that can be passed as a block to WebMock's stub_request method.
+  def create_response_proc(callback_stack)
+    execute_callback_with_super = ->(stack, request, params, stub) {
+                        # the p_* args represent arguments potentially passed by the user's super call.
+      stack.last.call(request, params, stub) do |p_request, p_params, p_stub|
+        if stack.count == 1
+          {}
+        else
+          execute_callback_with_super.call(stack[0...-1], p_request || request, p_params || params, p_stub || stub)
+        end
+      end
+    }
+
+    # This proc is passed as a block to #to_return when creating the stub.
+    Proc.new do |request|
+      params = extract_params(request)
+
+      results = execute_callback_with_super.call(
+        callback_stack, request, params, @stub)
+
+      results[:body] = results[:body].to_json unless results[:body].is_a? String
+      results
+    end
+  end
+
+  # Bang is there because this method populates @param_indices.
+  def build_url_regex!(url)
+    regex = ""
+    separate(url).each_with_index do |x, slash_index|
+      regex += '/' unless slash_index == 0
+      # If there is a colon, it's a parameter. i.e. /resource/:id.json
+      if x.include? ':' and !(x[1..-1] =~ /^\d$/) # If it's just numbers, it's probably a port number
+        # We split by dot at this point to separate the parameter from any
+        # format/domain related suffix.
+        dot_split = x.split('.')
+        inner_regex = []
+
+        dot_split.each_with_index do |name, dot_index|
+          # A parameter can show up after a dot as well. i.e. /resource/:id.:format
+          inner_regex << if name.include? ':'
+            param_name = name[1..-1]
+            @param_indices[param_name] = ParamIndices.new(slash_index, dot_index)
+            # Add .+ regex to capture any data at this point in the url.
+            ".+"
+          else
+            # If there's no colon, it's a static part of the target url.
+            Regexp.escape(name)
+          end
+        end
+
+        # "inner_regex" was built by splitting on dots, so we put the dots back.
+        regex += inner_regex.join('\.')
+      else
+        # No colon, so this segment is static.
+        regex += Regexp.escape(x)
+      end
+    end
+    Regexp.new regex
+  end
+
+  def extract_params(request)
+    url = separate request.uri
+    params = Params.new
+    @param_indices.each do |param_name, index|
+      value = url[index.slash].split('.')[index.dot]
+
+      params[param_name] = value
+    end
+    params
+  end
+
+  def separate(url)
+    url.to_s[url.to_s.index('://')+3..-1].split '/'
+  end
+end

data/lib/endpoint/stub.rb

@@ -1,3 +1,4 @@
+require 'endpoint/response'
 require 'endpoint_stub'
 require 'webmock'
 
@@ -21,7 +22,7 @@ module Endpoint
       # custom responses if needed.
       def create_for(model, options={}, &block)
         model = assure_model model
-        return if stubs.keys.include? model
+        return if stubs.keys.map(&:name).include? model.name
         new_stub = Stub.new(model, options)
 
         EndpointStub::Config.default_responses.each do |response|
@@ -46,6 +47,10 @@ module Endpoint
         @stubs[assure_model(model)]
       end
 
+      def clear_all_records!
+        @stubs.values.each(&:clear_records!)
+      end
+
       ##
       # Clears all endpoint stubs.
       def clear!
@@ -59,6 +64,10 @@ module Endpoint
         create_for model or get_for model
       end
 
+      def each(&block)
+        @stubs.each(&block)
+      end
+
       private
       def assure_model(model)
         if model.ancestors.include? ActiveResource::Base
@@ -71,12 +80,13 @@ module Endpoint
 
     attr_reader :defaults
     attr_reader :model
+    attr_reader :site
     attr_accessor :records
     def initialize(model, options)
       @defaults = options[:defaults] || {}
 
       @model = model
-      @site = URI "#{model.site}/#{model.name.underscore.pluralize}"
+      @site = URI "#{model.site}/#{model.name.split('::').last.underscore.pluralize}"
 
       @responses = {}
 
@@ -93,6 +103,7 @@ module Endpoint
       attrs[:id] = current_id
       attrs.merge!(@defaults) { |k,a,b| a }
       @records << attrs
+      attrs
     end
 
     ##
@@ -117,6 +128,14 @@ module Endpoint
       end
     end
 
+    ##
+    # Clear all records in this stub.
+    def clear_records!
+      @records = []
+    end
+
+    ##
+    # Get the record at the given id. Accepts strings as well as ints.
     def record(id)
       @records[id.to_i]
     end
@@ -171,25 +190,53 @@ module Endpoint
     # interact with the stubbed records.
     def mock_response(type, route='', proc=nil, &block)
       proc = block if block_given?
+      route = clean_route route
 
+      @responses[type] ||= {}
+      @responses[type][route].deactivate! if @responses[type][route]
+      @responses[type][route] = Response.new(type, prepare_uri(type, route), self, &proc)
+      @responses[type][route].activate!
+    end
+
+    ##
+    # Same thing as mock_response, except it will not overWRITE existing
+    # mocks. Instead, it allows you to call a block inside of your response
+    # which will act as a 'super' call, invoking previously defined 
+    # responses. Yielding inside a top-level response will give you
+    # an empty hash, so no nil related issues should arrise (unless of 
+    # course the super-response returns nil, which it shouldn't).
+    # 
+    # Also note that this does not re-activate a deactivated response.
+    def override_response(type, route, proc=nil, &block)
+      proc = block if block_given?
       route = clean_route route
 
-      site = "#{@site.scheme}://#{@site.host}"
-      path = @site.path.split(/\/+/).reject(&:empty?)
-      if route[0] == '.' && !route.include?('/')
-        # This allows passing '.json', etc as the route
-        if path.last
-          path = path[0...-1] + [path.last+route]
-        else
-          site += route
-        end
+      if @responses[type] and @responses[type][route]
+        @responses[type][route].add_to_stack(&proc)
       else
-        path += route.split('/')
+        mock_response(type, route, proc)
       end
+    end
 
-      @responses[type] ||= {}
-      @responses[type][route] = Response.new(type, URI.parse(site+'/'+path.join('/')), self, &proc)
-      @responses[type][route].activate!
+    ##
+    # Overrides all currently assigned responses. Will not have any effect
+    # on responses mocked after this method is called.
+    def override_all(&block)
+      @responses.each do |type, responses|
+        responses.each do |route, response|
+          response.add_to_stack(&block)
+        end
+      end
+    end
+
+    ##
+    # Removes all overrides, reducing each response to their originals.
+    def drop_overrides!
+      @responses.each do |type, responses|
+        responses.each do |route, response|
+          response.drop_overrides!
+        end
+      end
     end
 
     ##
@@ -204,104 +251,28 @@ module Endpoint
     end
 
     private
-    def clean_route(route)
-      route = route[1..-1] if route[0] == '/'
-      route = route[0...-1] if route[-1] == '/'
-      route
-    end
-
-    class Response
-      include WebMock::API
-
-      # For remembering where a uri-based parameter is located.
-      ParamIndices = Struct.new(:slash, :dot)
-      # Allows more comfortable use of Symbol keys when accessing
-      # params (which are string keys).
-      class Params < Hash
-        def [](key)
-          super(key.to_s)
-        end
-        def []=(key, value)
-          super(key.to_s, value)
-        end
-      end
-
-      def initialize(type, url, stub, &proc)
-        @param_indices = {}
-        
-        @url_regex = build_url_regex!(url)
-
-        @type = type
-        @proc = proc
-        @stub = stub
-      end
-
-      # Should be called only once, internally to perform the actual WebMock stubbing.
-      def activate!
-        @stubbed_request = stub_request(@type, @url_regex).to_return do |request|
-          params = extract_params(request)
-
-          results = @proc.call(request, params, @stub)
-          results[:body] = results[:body].to_json unless results[:body].is_a? String
-          results
-        end
-      end
-
-      # This should remove the request stubbed by #activate!
-      def deactivate!
-        remove_request_stub @stubbed_request
-      end
+    def prepare_uri(type, route)
+      site = "#{@site.scheme}://#{@site.host}:#{@site.port}"
+      path = @site.path.split(/\/+/).reject(&:empty?)
 
-      private
-      # Bang is there because this method populates @param_indices.
-      def build_url_regex!(url)
-        regex = ""
-        separate(url).each_with_index do |x, slash_index|
-          regex += '/' unless slash_index == 0
-          # If there is a colon, it's a parameter. i.e. /resource/:id.json
-          if x.include? ':' and !(x[1..-1] =~ /^\d$/) # If it's just numbers, it's probably a port number
-            # We split by dot at this point to separate the parameter from any
-            # format/domain related suffix.
-            dot_split = x.split('.')
-            inner_regex = []
-
-            dot_split.each_with_index do |name, dot_index|
-              # A parameter can show up after a dot as well. i.e. /resource/:id.:format
-              inner_regex << if name.include? ':'
-                param_name = name[1..-1]
-                @param_indices[param_name] = ParamIndices.new(slash_index, dot_index)
-                # Add .+ regex to capture any data at this point in the url.
-                ".+"
-              else
-                # If there's no colon, it's a static part of the target url.
-                Regexp.escape(name)
-              end
-            end
-
-            # "inner_regex" was built by splitting on dots, so we put the dots back.
-            regex += inner_regex.join('\.')
-          else
-            # No colon, so this segment is static.
-            regex += Regexp.escape(x)
-          end
+      if route[0] == '.' && !route.include?('/')
+        # This allows passing '.json', etc as the route
+        if path.last
+          path = path[0...-1] + [path.last+route]
+        else
+          site += route
         end
-        Regexp.new regex
+      else
+        path += route.split('/')
       end
 
-      def extract_params(request)
-        url = separate request.uri
-        params = Params.new
-        @param_indices.each do |param_name, index|
-          value = url[index.slash].split('.')[index.dot]
-
-          params[param_name] = value
-        end
-        params
-      end
+      URI.parse site+'/'+path.join('/')
+    end
 
-      def separate(url)
-        url.to_s[url.to_s.index('://')+3..-1].split '/'
-      end
+    def clean_route(route)
+      route = route[1..-1] if route[0] == '/'
+      route = route[0...-1] if route[-1] == '/'
+      route
     end
   end
 end

data/lib/endpoint_stub.rb

@@ -15,14 +15,12 @@ module EndpointStub
   # as per WebMock, unless relating to an ActiveResource 
   # model.
   def self.activate!
-    return if Config.activated
     WebMock.enable!
     Config.activated = true
   end
   # Disable endpoint stubbing.
   # This allows real HTTP requests again.
   def self.deactivate!
-    return unless Config.activated
     WebMock.disable!
     Config.activated = false
   end
@@ -34,12 +32,25 @@ module EndpointStub
     activate!
   end
 
+  # Default to being deactivated.
+  deactivate!
+
   # Feel free to add to these, and they will be applied to every 
   # stubbed endpoint thereafter.
   Config.default_responses = [
     ### Index ###
     [:get, '.json', ->(request, params, stub) {
-      { body: stub.records }
+      query = request.uri.query_values
+      
+      if !query || query.empty?
+        { body: stub.records }
+      else
+        {
+          body: stub.records.select do |record|
+              query.all? { |field, value| record[field] == value }
+            end
+        }
+      end
     }],
 
     ### Show ###
@@ -49,8 +60,8 @@ module EndpointStub
 
     ### Create ###
     [:post, '.json', ->(request, params, stub) {
-      stub.add_record(JSON.parse(request.body))
-      { body: '', 
+      record = stub.add_record(JSON.parse(request.body))
+      { body: record, 
         status: 201,
         headers: { 'Location' => stub.location(stub.last_id) }
       }
@@ -59,7 +70,7 @@ module EndpointStub
     ### Update ###
     [:put, '/:id.json', ->(request, params, stub) {
       if stub.update_record(params[:id], JSON.parse(request.body))
-        { body: '', status: 204}
+        { body: stub.records[params[:id].to_i], status: 204}
       else
         { body: "Failed to find #{stub.model_name} with id #{params[:id]}", 
           status: 404 }

data/lib/endpoint_stub/version.rb

@@ -1,3 +1,3 @@
 module EndpointStub
-  VERSION = "1.1.0"
+  VERSION = "1.4.5"
 end

data/spec/endpoint/stub_spec.rb

@@ -2,6 +2,17 @@ require 'spec_helper'
 
 class TestModel < ActiveResource::Base
   self.site = "http://www.not-a-site.com/api"
+  alias_method :to_param, :id
+end
+
+module TestModule
+  class InnerModel < ActiveResource::Base
+    self.site = "http://www.inner-test.com/api"
+  end
+end
+
+class TestModelWithPort < ActiveResource::Base
+  self.site = "http://not-a-site.com:777/api"
 end
 
 describe Endpoint::Stub, stub_spec: true do
@@ -29,6 +40,17 @@ describe Endpoint::Stub, stub_spec: true do
       Endpoint::Stub.create_for(TestModel, {defaults: { test_attr: 'hey' }})
       expect(Endpoint::Stub[TestModel].defaults.keys).to include :test_attr
     end
+
+    it 'assigns the url properly for namespaced models' do
+      subject = Endpoint::Stub.create_for TestModule::InnerModel
+      expect(subject.site.to_s).to_not include "test_module"
+      expect(subject.site.to_s).to include "inner_models"
+    end
+
+    it 'should work with a port number other than 80' do
+      Endpoint::Stub.create_for TestModelWithPort
+      expect{TestModelWithPort.create(test_attr: '...')}.to_not raise_error
+    end
   end
 
   describe '.clear_for' do
@@ -39,7 +61,6 @@ describe Endpoint::Stub, stub_spec: true do
     end
   end
 
-
   context 'With a stubbed model' do
     let!(:test_model_stub) { Endpoint::Stub.create_for(TestModel) }
     after(:each) do
@@ -75,6 +96,16 @@ describe Endpoint::Stub, stub_spec: true do
         subject.save
         expect(subject.test_attr).to eq "heyyyyyyy"
       end
+
+      it 'numbers should be converted to numbers' do
+        subject = TestModel.new
+        subject.test_attr = 'hello'
+        subject.test_num = 2.2
+        subject.save
+        subject = TestModel.find(subject.id)
+        expect(subject.test_num).to_not be_a String
+        expect(subject.test_num).to eq 2.2
+      end
     end
 
     describe 'creating a new record' do
@@ -87,9 +118,47 @@ describe Endpoint::Stub, stub_spec: true do
 
       it 'should work with .create method' do
         subject = TestModel.create(test_attr: 'wow')
-        expect(subject.id).to eq '0'
+        expect(subject.id).to eq 0
         expect(subject.test_attr).to eq 'wow'
       end
+
+      it 'ids should be properly converted to numbers' do
+        TestModel.create(test_attr: 'nice')
+        expect(TestModel.find(0).id).to_not be_a String
+        expect(TestModel.find(0).id).to eq 0
+      end
+
+      it 'should allow the record to be saved afterwards' do
+        subject = TestModel.create(test_attr: 'nice')
+        expect(test_model_stub.records.count).to eq 1
+        subject.test_attr = 'nice'
+        subject.save
+        subject.reload
+        expect(subject.test_attr).to eq 'nice'
+        expect(test_model_stub.records.count).to eq 1
+      end
+
+      it 'should allow comprehensive editing' do
+        2.times { |n| TestModel.create(test_attr: "cool#{n}") }
+        expect(test_model_stub.records.count).to eq 2
+
+        first = TestModel.first
+        expect(first.test_attr).to eq 'cool0'
+
+        first.test_attr = 'now this'
+        expect(first.save).to be_truthy
+        expect{first.reload}.to_not raise_error
+        expect(first.test_attr).to eq 'now this'
+
+        expect(TestModel.all.count).to eq 2
+
+        TestModel.all.map(&:test_attr).tap do |it|
+          expect(it).to include 'now this'
+          expect(it).to_not include 'cool0'
+        end
+
+        expect(TestModel.all.map(&:id).uniq).to eq TestModel.all.map(&:id)
+      end
     end
 
     describe 'destroying a record' do
@@ -117,8 +186,8 @@ describe Endpoint::Stub, stub_spec: true do
       end
     end
 
-    describe 'custom response' do
-      it 'should be addable to existing stubs' do
+    describe 'custom responses' do
+      it 'should be addable to existing mocks' do
         test_model_stub.records << { id: 0, test_attr: 'hey' }
 
         test_model_stub.mock_response(:put, '/:id/change') do |response, params, stub|
@@ -141,6 +210,55 @@ describe Endpoint::Stub, stub_spec: true do
         test_model_stub.unmock_response(:put, '/test')
         expect{TestModel.put(:test)}.to raise_error
       end
+
+      it 'should be able to overwrite existing mocks with no path' do
+        test_model_stub.records << { id: 0, test_attr: 'hey' }
+
+        test_model_stub.mock_response :get, '.json' do |response, params, stub|
+          { body: [{ id: 0, test_attr: 'overridden!' }] }
+        end
+
+        expect(TestModel.all.first.test_attr).to eq 'overridden!'
+      end
+
+      it 'should be able to override existing mocks and access the previous implementation' do
+        test_model_stub.records << { id: 0, test_attr: 'hey' }
+
+        test_model_stub.override_response :get, '.json' do |response, params, stub, &sup|
+          body = sup.call[:body]
+          body << { id: 1, test_attr: 'injected!' }
+          { body: body }
+        end
+
+        expect(TestModel.all.first.test_attr).to eq 'hey'
+        expect(TestModel.all.last.test_attr).to eq 'injected!'
+      end
+
+      it 'should be able to change the parameters for the previous implementation when overriding' do
+        test_model_stub.records += [{ id: 0, test_attr: 'hey'}, {id: 1, test_attr: 'second' }]
+
+        test_model_stub.override_response :get, '/:id.json' do |response, params, stub, &supre|
+          params[:id] = params[:id].to_i + 1
+          supre.call response, params
+        end
+
+        expect(TestModel.find(0).test_attr).to eq 'second'
+      end
+
+      it 'should be able to override all existing mocks' do
+        test_model_stub.records << { id: 0, test_attr: 'hey' }
+        dummy = Class.new do
+          def test; 'here we go'; end
+        end.new
+        expect(dummy).to receive(:test).twice
+
+        test_model_stub.override_all do |response, params, stub, &supre|
+          { body: dummy.test }
+        end
+
+        TestModel.all
+        TestModel.find(0) rescue ArgumentError
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,8 +2,15 @@ require 'endpoint_stub'
 require 'endpoint/stub'
 require 'net/http'
 require 'active_resource'
+$VERBOSE = nil
 
 RSpec.configure do |config|
+  EndpointStub.activate!
+
+  config.after :each do
+    Endpoint::Stub.clear_all_records!
+  end
+
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endpoint_stub
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.5
 platform: ruby
 authors:
 - Nigel Baillie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -77,21 +77,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/.name"
-- ".idea/.rakeTasks"
 - ".idea/dictionaries/devmini.xml"
-- ".idea/encodings.xml"
-- ".idea/endpoint_stub.iml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
 - ".idea/scopes/scope_settings.xml"
-- ".idea/vcs.xml"
 - ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - endpoint_stub.gemspec
+- lib/endpoint/response.rb
 - lib/endpoint/stub.rb
 - lib/endpoint_stub.rb
 - lib/endpoint_stub/version.rb