api_fixtures 0.0.1

data/lib/api_fixtures/dsl.rb

@@ -0,0 +1,36 @@
+require 'api_fixtures/fixtures'
+
+module ApiFixtures
+  module DSL
+    module InstanceDSL
+      def api
+        ApiFixtures::Fixtures
+      end
+    end
+
+    def self.extended(base)
+      base.class_attribute :api_fixture_paths
+      base.send(:include, InstanceDSL)
+
+      before_hook = [:before, :setup].find {|hook| base.respond_to?(hook) }
+      after_hook  = [:after, :teardown].find {|hook| base.respond_to?(hook) }
+
+      base.send(before_hook) do
+        ApiFixtures::Fixtures.clear
+        (api_fixture_paths || []).each do |path|
+          ApiFixtures::Fixtures.fixture('GET', path)
+        end
+      end
+
+      base.send(after_hook) do
+        ApiFixtures::Fixtures.assert_expected_calls(self)
+      end
+    end
+
+    def api_fixtures(*paths)
+      self.api_fixture_paths ||= []
+      self.api_fixture_paths += paths
+      self.api_fixture_paths.uniq!
+    end
+  end
+end

data/lib/api_fixtures/fixtures.rb

@@ -0,0 +1,82 @@
+module ApiFixtures
+  class Fixtures
+    FIXTURES = {
+      :get =>    {},
+      :put =>    {},
+      :post =>   {},
+      :delete => {}
+    }
+    EXPECTATIONS = []
+    CALLS = []
+
+    def self.normalize_method(method)
+      method.downcase.to_sym
+    end
+
+    def self.normalize_path(path)
+      path.gsub(/\.\w+$/, '')
+    end
+
+    def self.fixtures_folder
+      unless @fixtures_folder
+        if defined?(Rails)
+          @fixtures_folder = (Rails.root + 'test/api_fixtures')
+        end
+      end
+      @fixtures_folder
+    end
+
+    def self.fixtures_folder=(folder)
+      @fixtures_folder = folder
+    end
+
+    def self.fixture(method, path, response = nil)
+      ApiFixtures::Middleware.must_be_in_stack!
+
+      case response
+      when Hash
+        response = [200, {'Content-Type' => 'application/json; charset=utf-8'}, [response.to_json]]
+      when Array
+        case response[2]
+        when String
+          response[2] = [response[2]]
+        end
+      when nil
+        file_name = fixtures_folder + ('.' + path + '.json')
+        response = [200, {'Content-Type' => 'application/json; charset=utf-8'}, [File.read(file_name.to_s)]]
+      end
+
+      FIXTURES[normalize_method(method)][path] = response
+    end
+
+    def self.expect(method, path, options = {})
+      if options[:response]
+        fixture(method, path, options[:response])
+      end
+      EXPECTATIONS << [normalize_method(method), path]
+    end
+
+    def self.lookup(method, path)
+      method = normalize_method(method)
+      path   = normalize_path(path)
+      CALLS << [method, path]
+      FIXTURES[method][path]
+    end
+
+    def self.clear
+      FIXTURES[:get].clear
+      FIXTURES[:put].clear
+      FIXTURES[:post].clear
+      FIXTURES[:delete].clear
+
+      EXPECTATIONS.clear
+      CALLS.clear
+    end
+
+    def self.assert_expected_calls(test)
+      (EXPECTATIONS - CALLS).each do | method, path|
+        test.flunk("Expected API call: #{method.to_s.upcase} #{path}")
+      end
+    end
+  end
+end

data/lib/api_fixtures/middleware.rb

@@ -0,0 +1,23 @@
+module ApiFixtures
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      ApiFixtures::Fixtures.lookup(request.request_method, request.path) || @app.call(env)
+    end
+
+    def self.must_be_in_stack!
+      if defined?(Rails::Application)
+        unless Rails.application.middleware.include?(self)
+          raise "ApiFixtures::Middleware needs to be in the middleware stack"
+        end
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/api_fixtures.rb

@@ -0,0 +1,7 @@
+require 'api_fixtures/fixtures'
+require 'api_fixtures/middleware'
+require 'api_fixtures/dsl'
+
+module ApiFixtures
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: api_fixtures
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70290369209240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290369209240
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70290369208700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70290369208700
+description: 
+email:
+- mick@staugaard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/api_fixtures/dsl.rb
+- lib/api_fixtures/fixtures.rb
+- lib/api_fixtures/middleware.rb
+- lib/api_fixtures.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: An easy way to setup JSON API fixtures for your integration tests
+test_files: []