activeresource_httpmock_record 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d1fd3f9a67765252be923b335fbda678a73fb22
+  data.tar.gz: 8d3240b88e3babe086dcacb336bfbf11b431ede2
+SHA512:
+  metadata.gz: 7a779987f5998fa8f37068f4bd7686c4810fddc03795722d25161f07fb6c7898fd15e250d257177ac251834427ba17469dfa6f1f2201efac6afc2d6ec5b48729
+  data.tar.gz: 1d9dcb6ebe0c7c8b058e2cf786277e7f1fab28dd6fa9ff6aa5be0c81cc21271c07a82cc8281c203fdb3f497e9902b251185608b56029d1088dac28f697bb6d65

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activeresource_httpmock_record.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shintaro Kojima
+
+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,99 @@
+ActiveresourceHttpmockRecord
+============================
+
+Testing models which communicate with remote web services could be painful.
+This gem provides a simple way to record HTTP request and response through ActiveResource, and playback with ActiveResource::HttpMock.
+
+Features
+--------
+
+If your application uses ActiveResource:
+
+* ActiveresourceHttpmockRecord works together with your test code, records HTTP requests generated by an ActiveResource model and HTTP response coming from the remote web service.
+  * They're stored as YAML files to play back later
+* During the same test code runs after that, ActiveresourceHttpmockRecord mocks HTTP requests and responses recorded istead of creating new actual HTTP sessions with ActiveResource.
+
+
+Supported testing tool
+----------------------
+
+* RSpec
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'activeresource_httpmock_record'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activeresource_httpmock_record
+
+
+Usage
+-----
+
+### RSpec
+
+You may write your spec like:
+
+```ruby
+describe User do
+  subject(:user) { User.find(1) }
+
+  it 'has a name' do
+    expect(user.name).to be_present
+    expect(user.name).to be_a(String)
+  end
+end
+```
+
+When running it, ```User.find(1)``` causes a HTTP request.
+
+To activate ActiveresourceHttpmockRecord, add a metadata hash ```httpmock: <file_name>``` to groups or examples in your spec.
+
+```ruby
+describe User do
+  subject(:user) { User.find(1) }
+
+  it 'has a name', httpmock: a_user do
+    expect(user.name).to be_present
+    expect(user.name).to be_a(String)
+  end
+end
+```
+
+Once you run the spec, ActiveresourceHttpmockRecord record HTTP request and response as a ```a_user.yml```, and if you run it again, ActiveresourceHttpmockRecord load the HTTP session from ```file_name.yml``` and mock it for you.
+
+
+#### Warning
+
+ActiveresourceHttpmockRecord doesn't support a multi-threaded testing like Capybara with ```js: true``` option.
+
+
+Configuration
+-------------
+
+You can change the mock file store by adding the following lines (typically ```spec_helper.rb``` for RSpec):
+
+```ruby
+ActiveResourceHttpMock.configure do |config|
+  config.httpmock_path = '/path/to/directory'
+end
+```
+
+
+Contributing
+------------
+
+1. Fork it
+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/activeresource_httpmock_record.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_resource_http_mock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activeresource_httpmock_record'
+  spec.version       = ActiveResourceHttpMock::VERSION
+  spec.authors       = ['Shintaro Kojima']
+  spec.email         = ['goodies@codeout.net']
+  spec.description   = %q{Record HTTP request and response through ActiveResource, and play back with ActiveResource::HttpMock}
+  spec.summary       = %q{ActiveResource::HttpMock extenstion for testing}
+  spec.homepage      = 'https://github.com/codeout/activeresource_httpmock_record'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'activeresource'
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/active_resource_http_mock.rb

@@ -0,0 +1,17 @@
+require 'active_resource_http_mock/active_resource/http_mockable'
+require 'active_resource_http_mock/active_resource/request_loggable'
+require 'active_resource_http_mock/configuration'
+require 'active_resource_http_mock/rspec' if defined?(RSpec)
+
+module ActiveResourceHttpMock
+  class << self
+    def configuration
+      @configuration ||= ActiveResourceHttpMock::Configuration.new
+    end
+    alias config configuration
+
+    def configure(&block)
+      yield configuration if block_given?
+    end
+  end
+end

data/lib/active_resource_http_mock/active_resource/http_mockable.rb

@@ -0,0 +1,32 @@
+require 'active_resource/connection'
+require 'active_resource/http_mock'
+
+module ActiveResourceHttpMock
+  module ActiveResource
+    module HttpMockable
+      def self.included(base)
+        base.class_eval do
+          private
+
+          def http
+            if Thread.current[:httpmock]
+              _http_with_mock_
+            else
+              _http_without_mock_
+            end
+          end
+
+          def _http_with_mock_
+            @http ||= ::ActiveResource::HttpMock.new(@site)
+          end
+
+          def _http_without_mock_
+            configure_http(new_http)
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveResource::Connection.send :include, ActiveResourceHttpMock::ActiveResource::HttpMockable

data/lib/active_resource_http_mock/active_resource/request_loggable.rb

@@ -0,0 +1,31 @@
+require 'active_resource/connection'
+require 'active_support/notifications'
+
+module ActiveResourceHttpMock
+  module ActiveResource
+    module RequestLoggable
+      def self.included(base)
+        base.class_eval do
+          private
+
+          # OPTIMIZE: It looks hard to swap Connection object with modified one as ActiveResource::* works together monolithically
+          def request(method, path, *arguments)
+            result = ActiveSupport::Notifications.instrument("request.active_resource") do |payload|
+              payload[:method]      = method
+              payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
+              payload[:request]     = arguments  # monkey patch for request logging
+              payload[:result]      = http.send(method, path, *arguments)
+            end
+            handle_response(result)
+          rescue Timeout::Error => e
+            raise TimeoutError.new(e.message)
+          rescue OpenSSL::SSL::SSLError => e
+            raise SSLError.new(e.message)
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveResource::Connection.send :include, ActiveResourceHttpMock::ActiveResource::RequestLoggable

data/lib/active_resource_http_mock/configuration.rb

@@ -0,0 +1,19 @@
+module ActiveResourceHttpMock
+  class Configuration
+    attr_accessor :httpmock_path, :url_encoder, :url_decoder
+
+    def initialize
+      self.httpmock_path = 'spec/fixtures/httpmock'
+      self.url_encoder   = ->(url) { url }
+      self.url_decoder   = ->(url) { url }
+    end
+
+    def encode_url(&block)
+      @url_encoder = block if block_given?
+    end
+
+    def decode_url(&block)
+      @url_decoder = block if block_given?
+    end
+  end
+end

data/lib/active_resource_http_mock/data_file.rb

@@ -0,0 +1,59 @@
+require 'active_resource/http_mock'
+require 'uri'
+require 'yaml'
+
+module ActiveResourceHttpMock
+  class DataFile
+    def initialize(context)
+      @context = context
+    end
+
+    def data_dir
+      if defined?(Rails)
+        File.join(Rails.root, ActiveResourceHttpMock.config.httpmock_path)
+      else
+        ActiveResourceHttpMock.config.httpmock_path
+      end
+    end
+
+    def load_mocks
+      return unless data_file_exists?
+
+      requests = YAML.load_file(data_file_path).map {|request|
+        url = ActiveResourceHttpMock.config.url_decoder.call(request[1])
+        request[1] = URI.parse(url).request_uri
+        request
+      }
+
+      ::ActiveResource::HttpMock.respond_to(false) {|mock|
+        requests.each {|request| mock.send *request }
+      }
+    end
+
+    def dump_mocks(responses)
+      yaml = YAML.dump(
+        responses.map {|response|
+          response[1] = ActiveResourceHttpMock.config.url_encoder.call(response[1])
+          response
+        }
+      )
+
+      File.write data_file_path, yaml
+    end
+
+    private
+
+    def data_file_exists?
+      File.exists?(data_file_path)
+    end
+
+    def data_file_path
+      ensure_data_dir!
+      File.join(data_dir, @context.to_s) + '.yml'
+    end
+
+    def ensure_data_dir!
+      Dir.mkdir(data_dir) unless Dir.exist?(data_dir)
+    end
+  end
+end

data/lib/active_resource_http_mock/log_subscriber.rb

@@ -0,0 +1,29 @@
+require 'active_support/log_subscriber'
+
+module ActiveResourceHttpMock
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    class_attribute :events
+    self.events = {}
+
+    def self.responses
+      events.values
+    end
+
+    def request(event)
+      req = compose_event(event)
+      events[req[0..1].join('%')] = req
+    end
+
+    private
+
+    def compose_event(event)
+      [
+        event.payload[:method],
+        event.payload[:request_uri],
+        event.payload[:request].last,
+        event.payload[:result].body,
+        event.payload[:result].code
+      ]
+    end
+  end
+end

data/lib/active_resource_http_mock/rspec.rb

@@ -0,0 +1,50 @@
+require 'active_support/notifications'
+require 'rspec'
+require 'active_resource_http_mock/data_file'
+require 'active_resource_http_mock/log_subscriber'
+
+module ActiveResourceHttpMock
+  module RSpec
+    class << self
+      def configure
+        ::RSpec.configure do |config|
+          config.include self
+
+          config.around :each do |example|
+            if (context = example.metadata[:httpmock]) && example.metadata[:js].blank?
+              data = ActiveResourceHttpMock::DataFile.new(context)
+
+              if data.load_mocks
+                enable_http_mock
+                begin
+                  example.run
+                ensure
+                  disable_http_mock
+                end
+              else
+                ActiveResourceHttpMock::LogSubscriber.events.clear
+                example.run
+                data.dump_mocks ActiveResourceHttpMock::LogSubscriber.responses unless @example.exception
+              end
+            else
+              example.run
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def enable_http_mock
+      Thread.current[:httpmock] = true
+    end
+
+    def disable_http_mock
+      Thread.current[:httpmock] = nil
+    end
+  end
+end
+
+ActiveResourceHttpMock::RSpec.configure
+ActiveResourceHttpMock::LogSubscriber.attach_to :active_resource

data/lib/active_resource_http_mock/version.rb

@@ -0,0 +1,3 @@
+module ActiveResourceHttpMock
+  VERSION = '0.0.2'
+end

data/lib/activeresource_httpmock_record.rb

@@ -0,0 +1 @@
+require 'active_resource_http_mock'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: activeresource_httpmock_record
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Shintaro Kojima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-06 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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Record HTTP request and response through ActiveResource, and play back
+  with ActiveResource::HttpMock
+email:
+- goodies@codeout.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activeresource_httpmock_record.gemspec
+- lib/active_resource_http_mock.rb
+- lib/active_resource_http_mock/active_resource/http_mockable.rb
+- lib/active_resource_http_mock/active_resource/request_loggable.rb
+- lib/active_resource_http_mock/configuration.rb
+- lib/active_resource_http_mock/data_file.rb
+- lib/active_resource_http_mock/log_subscriber.rb
+- lib/active_resource_http_mock/rspec.rb
+- lib/active_resource_http_mock/version.rb
+- lib/activeresource_httpmock_record.rb
+homepage: https://github.com/codeout/activeresource_httpmock_record
+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.0.3
+signing_key: 
+specification_version: 4
+summary: ActiveResource::HttpMock extenstion for testing
+test_files: []