endpoint_stub 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b16dff51967c4be2433bd1743c9fcd182775613e
+  data.tar.gz: f2b80f0274615d21885838acf3ce83a7b5e405d9
+SHA512:
+  metadata.gz: 3f1f45d0961b3c4ad738d76789b5a49a8ef3170f0f64f390a07f139dd14035c85231d2599d063127941999b17013f4f903e6dcb6a144939285421739d4f04a94
+  data.tar.gz: ac4bf26b1026758711958739f75bbdcbb984454e63fdb32f8c1e7cf0829530bb7f4ec10d8aceaa667a73dbbc89d2158f4910fe5fae87a80993cf4670c33dfaa0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.idea/.name

@@ -0,0 +1 @@
+endpoint_stub

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build endpoint_stub-0.0.1.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install endpoint_stub-0.0.1.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v0.0.1 and build and push endpoint_stub-0.0.1.gem to Rubygems" fullCmd="release" taksId="release" /></RakeGroup></Settings>

data/.idea/dictionaries/devmini.xml

@@ -0,0 +1,3 @@
+<component name="ProjectDictionaryState">
+  <dictionary name="devmini" />
+</component>

data/.idea/encodings.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
+</project>
+

data/.idea/endpoint_stub.iml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="CompassSettings">
+    <option name="compassSupportEnabled" value="true" />
+  </component>
+  <component name="FacetManager">
+    <facet type="gem" name="Ruby Gem">
+      <configuration>
+        <option name="GEM_APP_ROOT_PATH" value="$MODULE_DIR$" />
+        <option name="GEM_APP_TEST_PATH" value="" />
+        <option name="GEM_APP_LIB_PATH" value="$MODULE_DIR$/lib" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel (v4.0.8, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activeresource (v4.0.0, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v4.0.8, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="addressable (v2.3.6, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="builder (v3.1.4, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.5.3, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="crack (v0.4.2, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v0.6.11, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.10.1, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rails-observers (v0.1.2, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.3.2, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.0.0, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.0.2, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.0.2, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.0.2, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.0.2, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="safe_yaml (v1.0.3, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thread_safe (v0.3.4, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo (v0.3.40, RVM: ruby-2.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="webmock (v1.18.0, RVM: ruby-2.1.1) [gem]" level="application" />
+  </component>
+</module>
+

data/.idea/misc.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectInspectionProfilesVisibleTreeState">
+    <entry key="Project Default">
+      <profile-state>
+        <expanded-state>
+          <State>
+            <id />
+          </State>
+          <State>
+            <id>Cucumber</id>
+          </State>
+          <State>
+            <id>Naming ConventionsRuby</id>
+          </State>
+          <State>
+            <id>Rails</id>
+          </State>
+          <State>
+            <id>Ruby</id>
+          </State>
+        </expanded-state>
+        <selected-state>
+          <State>
+            <id>CoffeeScript</id>
+          </State>
+        </selected-state>
+      </profile-state>
+    </entry>
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-2.1.1" project-jdk-type="RUBY_SDK" />
+  <component name="masterDetails">
+    <states>
+      <state key="ScopeChooserConfigurable.UI">
+        <settings>
+          <splitter-proportions>
+            <option name="proportions">
+              <list>
+                <option value="0.2" />
+              </list>
+            </option>
+          </splitter-proportions>
+        </settings>
+      </state>
+    </states>
+  </component>
+</project>
+

data/.idea/modules.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/endpoint_stub.iml" filepath="$PROJECT_DIR$/.idea/endpoint_stub.iml" />
+    </modules>
+  </component>
+</project>
+

data/.idea/scopes/scope_settings.xml

@@ -0,0 +1,5 @@
+<component name="DependencyValidationManager">
+  <state>
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </state>
+</component>

data/.idea/vcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
+

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--warnings
+--require spec_helper
+--format d

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rspec', '~> 3.0.0'
+end
+
+# Specify your gem's dependencies in endpoint_stub.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Resonious
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# EndpointStub
+
+I found that testing solutions for ActiveResource were either sub-optimal or
+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
+an interface for defining your own routes and logic.
+
+Nested resources are currently pending, but definitely implementable via custom
+response mocking.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'endpoint_stub'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install endpoint_stub
+
+## Usage
+
+Add
+
+    require 'endpoint_stub'
+
+to your spec_helper / test_helper.
+Then, in your tests, you can call
+
+    Endpoint::Stub.create_for(MyActiveResourceModel)
+
+which will bring MyActiveResourceModel to life!
+Here is a more in-depth example.
+
+    class Greeter < ActiveResource::Base
+        def say_hi_to(someone)
+            "#{self.greeting}, someone"
+        end
+
+        self.site = "http://example.com/api/greeter"
+    end
+
+    Endpoint::Stub.create_for(Greeter)
+    record = Greeter.create(greeting: 'hello')
+    record.say_hi_to('sir') # ===> "hello, sir"
+
+    record.greeting = 'hey...'
+    record.save     # ===> true
+    record.greeting     # ===> 'hey...'
+
+    record.destroy
+    record.destroyed?   # ===> true
+
+    Greeter.create(greeting: 'hi')
+    Greeter.create(greeting: 'ahoy')
+
+    Greeter.all # ===> [{id: 1, greeting: 'hi'}, {id: 2, greeting: 'ahoy'}]
+
+Also, custom responses and default attributes:
+
+    class Test < ActiveResource::Base
+        self.site = "http://example.com/api/whatever"
+    end
+
+    Endpoint::Stub.create_for(Test) do
+        add_default test_attr: 'nice'
+
+        mock_response(:put, '/:id/change') do |response, params, stub|
+          stub.update_record params[:id], test_attr: '*changed*'
+          { body: "did it" }
+        end
+    end
+
+    record = Test.create
+    record.test_attr     # ===> 'nice'
+    record.put(:change).body     # ===> 'did it'
+    record.reload
+    record.test_attr     # ===> '*changed*'
+
+Afterwards, custom responses can be un-mocked:
+
+    Endpoint::Stub[Test].unmock_response(:put, '/:id/change')    # ===> true
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/endpoint_stub/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/endpoint_stub.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'endpoint_stub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "endpoint_stub"
+  spec.version       = EndpointStub::VERSION
+  spec.authors       = ["Nigel Baillie"]
+  spec.email         = ["metreckk@gmail.com"]
+  spec.summary       = %q{Uses WebMock to intercept http requests to perform basic CRUD operations with ActiveResource.}
+  spec.description   = %q{
+    Kind of like the built-in HttpMock that ActiveResource comes with, except EntpointStub
+    actually creates and destroys records, and also allows you to bind custom logic to a
+    particular path. Kind of like a controller.
+  }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "activeresource"
+  spec.add_development_dependency "webmock"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/endpoint/stub.rb

@@ -0,0 +1,307 @@
+require 'endpoint_stub'
+require 'webmock'
+
+module Endpoint
+  ##
+  # Represents a stubbed endpoint that creates, updates, 
+  # destroys, and stores data based on http requests.
+  class Stub
+    @stubs = {}
+    class << self
+      attr_reader :stubs
+      ##
+      # Creates a fake endpoint for the given ActiveResource model.
+      # 
+      # The options hash currently only accepts :defaults, which allows
+      # you to define default attribute values for the endpoint to 
+      # consider on record creation.
+      # 
+      # If a block is supplied, it will be executed in the context
+      # of the new Endpoint::Stub, allowing you to elegantly mock
+      # custom responses if needed.
+      def create_for(model, options={}, &block)
+        model = assure_model model
+        return if stubs.keys.include? model
+        new_stub = Stub.new(model, options)
+
+        EndpointStub::Config.default_responses.each do |response|
+          new_stub.mock_response(*response)
+        end
+
+        @stubs[model] = new_stub
+
+        new_stub.instance_eval(&block) if block_given?
+        new_stub
+      end
+
+      ##
+      # Removes fake endpoint for the given model, meaning any
+      # ActiveResource activity on the model will raise errors
+      # once again.
+      def clear_for(model)
+        stubs.delete assure_model model
+      end
+
+      def get_for(model)
+        @stubs[assure_model(model)]
+      end
+
+      ##
+      # Clears all endpoint stubs.
+      def clear!
+        @stubs = {}
+      end
+
+      ##
+      # Gets or creates a stub for the given model.
+      # i.e. Endpoint::Stub[Post]
+      def [](model)
+        create_for model or get_for model
+      end
+
+      private
+      def assure_model(model)
+        if model.ancestors.include? ActiveResource::Base
+          model
+        else
+          Kernel.const_get model
+        end
+      end
+    end
+
+    attr_reader :defaults
+    attr_reader :model
+    attr_accessor :records
+    def initialize(model, options)
+      @defaults = options[:defaults] || {}
+
+      @model = model
+      @site = URI "#{model.site}/#{model.name.underscore.pluralize}"
+
+      @responses = {}
+
+      @records = []
+    end
+
+    ##
+    # Adds a record to the stub, automatically assigning an id as though
+    # it were in a database.
+    def add_record(attrs)
+      unless attrs.is_a? Hash
+        raise "Endpoint::Stub#add_record expects a Hash. Got #{attrs.class.name}."
+      end
+      attrs[:id] = current_id
+      attrs.merge!(@defaults) { |k,a,b| a }
+      @records << attrs
+    end
+
+    ##
+    # Updates the record with the given id with the given attributes.
+    def update_record(id, attrs)
+      unless attrs.is_a? Hash
+        raise "Endpoint::Stub#update_record expects a Hash. Got #{attrs.class.name}."
+      end
+      id = id.to_i
+      if @records[id]
+        @records[id].merge! attrs
+      end
+    end
+
+    ##
+    # Removes the record with the given id from the fake database.
+    def remove_record(id)
+      id = id.to_i
+      if @records[id]
+        @records[id] = nil
+        true
+      end
+    end
+
+    def record(id)
+      @records[id.to_i]
+    end
+
+    ##
+    # The last assigned id.
+    def last_id
+      @records.count-1
+    end
+
+    ##
+    # The next id for a record to be assigned to.
+    def current_id
+      @records.count
+    end
+
+    ##
+    # The name of the represented model in underscore notation.
+    def model_name
+      @model.name.underscore
+    end
+
+    ##
+    # Gets the url location for the given id, as used by RESTful
+    # record creation.
+    def location(id)
+      site = @site.to_s[-1] == '/' ? @site.to_s[0...-1] : @site
+      "#{site}/#{id}"
+    end
+
+    ##
+    # Adds default attributes for record creation.
+    def add_default(attrs)
+      @defaults.merge!(attrs)
+    end
+    alias_method :add_defaults, :add_default
+
+    ##
+    # Mock a custom response. Requires a type (http mthod), and route.
+    # This method will override any previous responses assigned to the
+    # given type and route.
+    # 
+    # The route is the uri relative to the record's assigned site and
+    # can be formatted similarly to rails routes. Such as:
+    # '/test/:some_param.json'
+    # or
+    # '.xml' to simply imply the model's site with '.xml' appended.
+    # 
+    # Lastly, a proc or block is needed to actually handle requests.
+    # The proc will be called with the request object, the extracted 
+    # parameters from the uri, and the stub object so that you can 
+    # interact with the stubbed records.
+    def mock_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
+      else
+        path += route.split('/')
+      end
+
+      @responses[type] ||= {}
+      @responses[type][route] = Response.new(type, URI.parse(site+'/'+path.join('/')), self, &proc)
+      @responses[type][route].activate!
+    end
+
+    ##
+    # Remove a mocked response with the given type and route.
+    def unmock_response(type, route)
+      route = clean_route route
+      if @responses[type] && @responses[type][route]
+        @responses[type][route].deactivate!
+        @responses[type][route] = nil
+        true
+      end
+    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
+
+      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
+        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
+  end
+end

data/lib/endpoint_stub/version.rb

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

data/lib/endpoint_stub.rb

@@ -0,0 +1,87 @@
+require "endpoint_stub/version"
+require 'endpoint/stub'
+require 'webmock'
+
+module EndpointStub
+  class Config
+    class << self
+      attr_accessor :activated
+      attr_accessor :default_responses
+    end
+  end
+
+  # Enable endpoint stubbing.
+  # This will cause all HTTP requests to raise an error,
+  # 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
+
+  # Calls deactivate, clears all stubs, then re-activates.
+  def self.refresh!
+    deactivate!
+    Endpoint::Stub.clear!
+    activate!
+  end
+
+  # 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 }
+    }],
+
+    ### Show ###
+    [:get, '/:id.json', ->(request, params, stub) {
+      { body: stub.records[params[:id].to_i] }
+    }],
+
+    ### Create ###
+    [:post, '.json', ->(request, params, stub) {
+      stub.add_record(JSON.parse(request.body))
+      { body: '', 
+        status: 201,
+        headers: { 'Location' => stub.location(stub.last_id) }
+      }
+    }],
+
+    ### Update ###
+    [:put, '/:id.json', ->(request, params, stub) {
+      if stub.update_record(params[:id], JSON.parse(request.body))
+        { body: '', status: 204}
+      else
+        { body: "Failed to find #{stub.model_name} with id #{params[:id]}", 
+          status: 404 }
+      end
+    }],
+
+    ### Destroy ###
+    [:delete, '/:id.json', ->(request, params, stub) {
+      if stub.remove_record(params[:id])
+        { body: '', status: 200}
+      else
+        { body: "Failed to find #{stub.model_name} with id #{params[:id]}", 
+          status: 404 }
+      end
+    }]
+  ]
+end
+
+class Array
+  def to_json
+    '['+map do |e| 
+      e.respond_to?(:to_json) ? e.to_json : e.to_s 
+    end.join(', ')+']'
+  end
+end

data/spec/endpoint/stub_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+class TestModel < ActiveResource::Base
+  self.site = "http://www.not-a-site.com/api"
+end
+
+describe Endpoint::Stub, stub_spec: true do
+  before(:each) { EndpointStub.refresh! }
+
+  describe '.stubs' do
+    it 'should be a global hash of endpoint stubs, {modle => endpoint_stub}' do
+      expect(Endpoint::Stub.stubs).to be_a Hash
+    end
+  end
+
+  context 'http requests' do
+    it 'should fail when nothing is stubbed' do
+      expect{Net::HTTP.get "whocares.com", '/'}.to raise_error WebMock::NetConnectNotAllowedError
+    end
+  end
+
+  describe '.create_for' do
+    it 'should create a new Endpoint::Stub for the given ActiveResource model' do
+      Endpoint::Stub.create_for TestModel
+      expect(Endpoint::Stub.stubs.keys).to include TestModel
+    end
+
+    it 'should be able to set default attributes' do
+      Endpoint::Stub.create_for(TestModel, {defaults: { test_attr: 'hey' }})
+      expect(Endpoint::Stub[TestModel].defaults.keys).to include :test_attr
+    end
+  end
+
+  describe '.clear_for' do
+    it 'should remove the Endpoint::Stub entry for the given ActiveResource model' do
+      Endpoint::Stub.create_for TestModel
+      Endpoint::Stub.clear_for TestModel
+      expect(Endpoint::Stub.stubs.keys).to_not include TestModel
+    end
+  end
+
+
+  context 'With a stubbed model' do
+    let!(:test_model_stub) { Endpoint::Stub.create_for(TestModel) }
+    after(:each) do
+      Endpoint::Stub.clear_for TestModel
+    end
+
+    describe '.find' do
+      it 'retrieves the model' do
+        test_model_stub.records << { id: 0, test_attr: 'hey' }
+        test_model_stub.records << { id: 1, test_attr: 'nice!' }
+
+        subject = TestModel.find 1
+        expect(subject.test_attr).to eq 'nice!'
+      end
+    end
+
+    describe '.all' do
+      it 'retrieves all of the models' do
+        test_model_stub.records << { id: 0, test_attr: 'first!' }
+        test_model_stub.records << { id: 1, test_attr: 'even better' }
+
+        subjects = TestModel.all
+        expect(subjects.count).to eq 2
+        expect(subjects.first.test_attr).to eq 'first!'
+        expect(subjects.last.test_attr).to eq 'even better'
+      end
+    end
+
+    describe 'setting record attributes' do
+      it 'should work' do
+        subject = TestModel.new
+        subject.test_attr = "heyyyyyyy"
+        subject.save
+        expect(subject.test_attr).to eq "heyyyyyyy"
+      end
+    end
+
+    describe 'creating a new record' do
+      it 'should work' do
+        subject = TestModel.new
+        subject.test_attr = "alright...."
+        subject.save
+        expect(subject.test_attr).to eq 'alright....'
+      end
+
+      it 'should work with .create method' do
+        subject = TestModel.create(test_attr: 'wow')
+        expect(subject.id).to eq '0'
+        expect(subject.test_attr).to eq 'wow'
+      end
+    end
+
+    describe 'destroying a record' do
+      it 'should work' do
+        test_model_stub.records << { id: 0, test_attr: 'first!' }
+        test_model_stub.records << { id: 1, test_attr: 'even better' }
+
+        TestModel.find(0).destroy
+
+        expect{TestModel.find(0)}.to raise_error
+      end
+    end
+
+    describe 'the mocked responses' do
+      it 'should be removable' do
+        test_model_stub.records << { id: 0, test_attr: 'hey' }
+
+        expect{TestModel.find(0).test_attr}.to_not raise_error
+
+        expect(
+          test_model_stub.unmock_response(:get, '/:id.json')
+        ).to be_truthy
+
+        expect{TestModel.find(0).test_attr}.to raise_error
+      end
+    end
+
+    describe 'custom response' do
+      it 'should be addable to existing stubs' do
+        test_model_stub.records << { id: 0, test_attr: 'hey' }
+
+        test_model_stub.mock_response(:put, '/:id/change') do |response, params, stub|
+          stub.update_record params[:id], test_attr: '*changed*'
+          { body: "did it" }
+        end
+        
+        subject = TestModel.find(0)
+        expect(subject.test_attr).to_not eq '*changed*'
+        expect(subject.put(:change).body).to eq 'did it'
+        subject.reload
+        expect(subject.test_attr).to eq '*changed*'
+      end
+
+      it 'should be removable' do
+        test_model_stub.mock_response(:put, '/test') do |r,p,s|
+          { body: 'test' }
+        end
+        expect{TestModel.put(:test)}.to_not raise_error
+        test_model_stub.unmock_response(:put, '/test')
+        expect{TestModel.put(:test)}.to raise_error
+      end
+    end
+  end
+end

data/spec/endpoint_stub_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe EndpointStub, endpoint_stub_spec: true do
+  describe '.activate!' do
+    it 'should make http requests raise WebMock::NetConnectNotAllowedError' do
+      EndpointStub.activate!
+      expect{Net::HTTP.get "test.com", "/nothing"}.to raise_error WebMock::NetConnectNotAllowedError
+    end
+  end
+
+  describe '.deactivate!' do
+    it 'should allow http requests once again' do
+      # TODO make this account for not being connected to the internet.
+      EndpointStub.activate!
+      EndpointStub.deactivate!
+      expect{Net::HTTP.get "example.com", "/foo"}.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+require 'endpoint_stub'
+require 'endpoint/stub'
+require 'net/http'
+require 'active_resource'
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: endpoint_stub
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Nigel Baillie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    Kind of like the built-in HttpMock that ActiveResource comes with,
+  except EntpointStub\n    actually creates and destroys records, and also allows
+  you to bind custom logic to a\n    particular path. Kind of like a controller.\n
+  \ "
+email:
+- metreckk@gmail.com
+executables: []
+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/stub.rb
+- lib/endpoint_stub.rb
+- lib/endpoint_stub/version.rb
+- spec/endpoint/stub_spec.rb
+- spec/endpoint_stub_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Uses WebMock to intercept http requests to perform basic CRUD operations
+  with ActiveResource.
+test_files:
+- spec/endpoint/stub_spec.rb
+- spec/endpoint_stub_spec.rb
+- spec/spec_helper.rb