Skip to content
This repository
tree: 71d18ce48e
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 336 lines (303 sloc) 12.268 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
require 'active_support/core_ext/kernel/reporting'
require 'active_support/core_ext/object/inclusion'

module ActiveResource
  class InvalidRequestError < StandardError; end #:nodoc:

  # One thing that has always been a pain with remote web services is testing. The HttpMock
  # class makes it easy to test your Active Resource models by creating a set of mock responses to specific
  # requests.
  #
  # To test your Active Resource model, you simply call the ActiveResource::HttpMock.respond_to
  # method with an attached block. The block declares a set of URIs with expected input, and the output
  # each request should return. The passed in block has any number of entries in the following generalized
  # format:
  #
  # mock.http_method(path, request_headers = {}, body = nil, status = 200, response_headers = {})
  #
  # * <tt>http_method</tt> - The HTTP method to listen for. This can be +get+, +post+, +put+, +delete+ or
  # +head+.
  # * <tt>path</tt> - A string, starting with a "/", defining the URI that is expected to be
  # called.
  # * <tt>request_headers</tt> - Headers that are expected along with the request. This argument uses a
  # hash format, such as <tt>{ "Content-Type" => "application/json" }</tt>. This mock will only trigger
  # if your tests sends a request with identical headers.
  # * <tt>body</tt> - The data to be returned. This should be a string of Active Resource parseable content,
  # such as Json.
  # * <tt>status</tt> - The HTTP response code, as an integer, to return with the response.
  # * <tt>response_headers</tt> - Headers to be returned with the response. Uses the same hash format as
  # <tt>request_headers</tt> listed above.
  #
  # In order for a mock to deliver its content, the incoming request must match by the <tt>http_method</tt>,
  # +path+ and <tt>request_headers</tt>. If no match is found an +InvalidRequestError+ exception
  # will be raised showing you what request it could not find a response for and also what requests and response
  # pairs have been recorded so you can create a new mock for that request.
  #
  # ==== Example
  # def setup
  # @matz = { :person => { :id => 1, :name => "Matz" } }.to_json
  # ActiveResource::HttpMock.respond_to do |mock|
  # mock.post "/people.json", {}, @matz, 201, "Location" => "/people/1.json"
  # mock.get "/people/1.json", {}, @matz
  # mock.put "/people/1.json", {}, nil, 204
  # mock.delete "/people/1.json", {}, nil, 200
  # end
  # end
  #
  # def test_get_matz
  # person = Person.find(1)
  # assert_equal "Matz", person.name
  # end
  #
  class HttpMock
    class Responder #:nodoc:
      def initialize(responses)
        @responses = responses
      end

      [ :post, :put, :get, :delete, :head ].each do |method|
        # def post(path, request_headers = {}, body = nil, status = 200, response_headers = {})
        # @responses[Request.new(:post, path, nil, request_headers)] = Response.new(body || "", status, response_headers)
        # end
        module_eval <<-EOE, __FILE__, __LINE__ + 1
def #{method}(path, request_headers = {}, body = nil, status = 200, response_headers = {})
request = Request.new(:#{method}, path, nil, request_headers)
response = Response.new(body || "", status, response_headers)

delete_duplicate_responses(request)

@responses << [request, response]
end
EOE
      end

    private

      def delete_duplicate_responses(request)
        @responses.delete_if {|r| r[0] == request }
      end
    end

    class << self

      # Returns an array of all request objects that have been sent to the mock. You can use this to check
      # if your model actually sent an HTTP request.
      #
      # ==== Example
      # def setup
      # @matz = { :person => { :id => 1, :name => "Matz" } }.to_json
      # ActiveResource::HttpMock.respond_to do |mock|
      # mock.get "/people/1.json", {}, @matz
      # end
      # end
      #
      # def test_should_request_remote_service
      # person = Person.find(1) # Call the remote service
      #
      # # This request object has the same HTTP method and path as declared by the mock
      # expected_request = ActiveResource::Request.new(:get, "/people/1.json")
      #
      # # Assert that the mock received, and responded to, the expected request from the model
      # assert ActiveResource::HttpMock.requests.include?(expected_request)
      # end
      def requests
        @@requests ||= []
      end

      # Returns the list of requests and their mocked responses. Look up a
      # response for a request using <tt>responses.assoc(request)</tt>.
      def responses
        @@responses ||= []
      end

      # Accepts a block which declares a set of requests and responses for the HttpMock to respond to in
      # the following format:
      #
      # mock.http_method(path, request_headers = {}, body = nil, status = 200, response_headers = {})
      #
      # === Example
      #
      # @matz = { :person => { :id => 1, :name => "Matz" } }.to_json
      # ActiveResource::HttpMock.respond_to do |mock|
      # mock.post "/people.json", {}, @matz, 201, "Location" => "/people/1.json"
      # mock.get "/people/1.json", {}, @matz
      # mock.put "/people/1.json", {}, nil, 204
      # mock.delete "/people/1.json", {}, nil, 200
      # end
      #
      # Alternatively, accepts a hash of <tt>{Request => Response}</tt> pairs allowing you to generate
      # these the following format:
      #
      # ActiveResource::Request.new(method, path, body, request_headers)
      # ActiveResource::Response.new(body, status, response_headers)
      #
      # === Example
      #
      # Request.new(:#{method}, path, nil, request_headers)
      #
      # @matz = { :person => { :id => 1, :name => "Matz" } }.to_json
      #
      # create_matz = ActiveResource::Request.new(:post, '/people.json', @matz, {})
      # created_response = ActiveResource::Response.new("", 201, {"Location" => "/people/1.json"})
      # get_matz = ActiveResource::Request.new(:get, '/people/1.json', nil)
      # ok_response = ActiveResource::Response.new("", 200, {})
      #
      # pairs = {create_matz => created_response, get_matz => ok_response}
      #
      # ActiveResource::HttpMock.respond_to(pairs)
      #
      # Note, by default, every time you call +respond_to+, any previous request and response pairs stored
      # in HttpMock will be deleted giving you a clean slate to work on.
      #
      # If you want to override this behavior, pass in +false+ as the last argument to +respond_to+
      #
      # === Example
      #
      # ActiveResource::HttpMock.respond_to do |mock|
      # mock.send(:get, "/people/1", {}, "JSON1")
      # end
      # ActiveResource::HttpMock.responses.length #=> 1
      #
      # ActiveResource::HttpMock.respond_to(false) do |mock|
      # mock.send(:get, "/people/2", {}, "JSON2")
      # end
      # ActiveResource::HttpMock.responses.length #=> 2
      #
      # This also works with passing in generated pairs of requests and responses, again, just pass in false
      # as the last argument:
      #
      # === Example
      #
      # ActiveResource::HttpMock.respond_to do |mock|
      # mock.send(:get, "/people/1", {}, "JSON1")
      # end
      # ActiveResource::HttpMock.responses.length #=> 1
      #
      # get_matz = ActiveResource::Request.new(:get, '/people/1.json', nil)
      # ok_response = ActiveResource::Response.new("", 200, {})
      #
      # pairs = {get_matz => ok_response}
      #
      # ActiveResource::HttpMock.respond_to(pairs, false)
      # ActiveResource::HttpMock.responses.length #=> 2
      #
      # # If you add a response with an existing request, it will be replaced
      #
      # fail_response = ActiveResource::Response.new("", 404, {})
      # pairs = {get_matz => fail_response}
      #
      # ActiveResource::HttpMock.respond_to(pairs, false)
      # ActiveResource::HttpMock.responses.length #=> 2
      #
      def respond_to(*args) #:yields: mock
        pairs = args.first || {}
        reset! if args.last.class != FalseClass

        if block_given?
          yield Responder.new(responses)
        else
          delete_responses_to_replace pairs.to_a
          responses.concat pairs.to_a
          Responder.new(responses)
        end
      end

      def delete_responses_to_replace(new_responses)
        new_responses.each{|nr|
          request_to_remove = nr[0]
          @@responses = responses.delete_if{|r| r[0] == request_to_remove}
        }
      end

      # Deletes all logged requests and responses.
      def reset!
        requests.clear
        responses.clear
      end
    end

    # body? methods
    { true => %w(post put),
      false => %w(get delete head) }.each do |has_body, methods|
      methods.each do |method|
        # def post(path, body, headers)
        # request = ActiveResource::Request.new(:post, path, body, headers)
        # self.class.requests << request
        # if response = self.class.responses.assoc(request)
        # response[1]
        # else
        # raise InvalidRequestError.new("Could not find a response recorded for #{request.to_s} - Responses recorded are: - #{inspect_responses}")
        # end
        # end
        module_eval <<-EOE, __FILE__, __LINE__ + 1
def #{method}(path, #{'body, ' if has_body}headers)
request = ActiveResource::Request.new(:#{method}, path, #{has_body ? 'body, ' : 'nil, '}headers)
self.class.requests << request
if response = self.class.responses.assoc(request)
response[1]
else
raise InvalidRequestError.new("Could not find a response recorded for \#{request.to_s} - Responses recorded are: \#{inspect_responses}")
end
end
EOE
      end
    end

    def initialize(site) #:nodoc:
      @site = site
    end

    def inspect_responses #:nodoc:
      self.class.responses.map { |r| r[0].to_s }.inspect
    end
  end

  class Request
    attr_accessor :path, :method, :body, :headers

    def initialize(method, path, body = nil, headers = {})
      @method, @path, @body, @headers = method, path, body, headers
    end

    def ==(req)
      path == req.path && method == req.method && headers_match?(req)
    end

    def to_s
      "<#{method.to_s.upcase}: #{path} [#{headers}] (#{body})>"
    end

    private

    def headers_match?(req)
      # Ignore format header on equality if it's not defined
      format_header = ActiveResource::Connection::HTTP_FORMAT_HEADER_NAMES[method]
      if headers[format_header].present? || req.headers[format_header].blank?
        headers == req.headers
      else
        headers.dup.merge(format_header => req.headers[format_header]) == req.headers
      end
    end
  end

  class Response
    attr_accessor :body, :message, :code, :headers

    def initialize(body, message = 200, headers = {})
      @body, @message, @headers = body, message.to_s, headers
      @code = @message[0,3].to_i

      resp_cls = Net::HTTPResponse::CODE_TO_OBJ[@code.to_s]
      if resp_cls && !resp_cls.body_permitted?
        @body = nil
      end

      if @body.nil?
        self['Content-Length'] = "0"
      else
        self['Content-Length'] = body.size.to_s
      end
    end

    # Returns true if code is 2xx,
    # false otherwise.
    def success?
      code.in?(200..299)
    end

    def [](key)
      headers[key]
    end

    def []=(key, value)
      headers[key] = value
    end

    # Returns true if the other is a Response with an equal body, equal message
    # and equal headers. Otherwise it returns false.
    def ==(other)
      if (other.is_a?(Response))
        other.body == body && other.message == message && other.headers == headers
      else
        false
      end
    end
  end

  class Connection
    private
      silence_warnings do
        def http
          @http ||= HttpMock.new(@site)
        end
      end
  end
end
Something went wrong with that request. Please try again.