api_taster 0.4.6 → 0.4.7

data/README.md

@@ -19,7 +19,7 @@ API Taster compared to alternatives, have the following advantages:
 Add API Taster in your gemfile:
 
 ```ruby
-gem 'api_taster', :group => :development
+gem 'api_taster'
 ```
 Mount API Taster, this will allow you to visit API Taster from within your app. For example:
 
@@ -63,6 +63,21 @@ end
 
 If you use a test factory such as [FactoryGirl](https://github.com/thoughtbot/factory_girl), you can require your test factories and share the params. For example in FactoryGirl you can use the `attributes_for(:name_of_factory)` method.
 
+### Global Params
+
+If there are certain params (such as API version and auth token) that need to be present in every API endpoint, you may set them in `ApiTaster.global_params` before `ApiTaster.routes`:
+
+```ruby
+ApiTaster.global_params = {
+  :version    => 1,
+  :auth_token => 'teGpfbVitpnUwm7qStf9'
+}
+
+ApiTaster.routes do
+  # your route definitions
+end
+```
+
 ### Missing Route Definitions Detection
 
 Instead of manually finding out which route definitions you need, API Taster provides a warning page that shows you all the missing definitions.

data/app/controllers/api_taster/application_controller.rb

@@ -1,5 +1,13 @@
 module ApiTaster
   class ApplicationController < ActionController::Base
     layout proc { |controller| controller.request.xhr? ? nil : 'api_taster/application' }
+
+    before_filter :reload_routes
+
+    private
+
+    def reload_routes
+      load Rails.application.root.join('config/routes.rb')
+    end
   end
 end

data/lib/api_taster.rb

@@ -7,6 +7,9 @@ require 'api_taster/mapper'
 require 'api_taster/form_builder'
 
 module ApiTaster
+  mattr_accessor :global_params
+  self.global_params = {}
+
   def self.routes(&block)
     Route.mappings = Proc.new { block }
   end

data/lib/api_taster/mapper.rb

@@ -30,9 +30,9 @@ module ApiTaster
           }
         else
           Route.supplied_params[route[:id]] ||= []
-          Route.supplied_params[route[:id]] << params
+          Route.supplied_params[route[:id]] << ApiTaster.global_params.merge(params)
         end
       end
     end
   end
-end
+end

data/lib/api_taster/version.rb

@@ -1,3 +1,3 @@
 module ApiTaster
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

data/spec/mapper_spec.rb

@@ -24,7 +24,27 @@ module ApiTaster
 
     before(:all) do
       Rails.application.routes.draw { resources :dummy_users }
+    end
+
+    context "#global_params" do
+      before(:all) do
+        ApiTaster.global_params = { :foo => 'bar' }
+
+        ApiTaster.routes do
+          get '/dummy_users/:id', :id => 1
+        end
+
+        Route.map_routes
+      end
 
+      it "merges params" do
+        route = Route.find_by_verb_and_path(:get, '/dummy_users/:id')
+
+        Route.supplied_params[route[:id]].should == [{ :foo => 'bar', :id => 1 }]
+      end
+    end
+
+    before(:all) do
       ApiTaster.routes do
         get '/dummy_users/:id', :id => 1
         post '/dummy_users'

data/spec/route_spec.rb

@@ -38,6 +38,10 @@ module ApiTaster
       Route.map_routes
     end
 
+    it "lazy loads the mapping" do
+      Route.mappings.should be_kind_of(Proc)
+    end
+
     it "#routes" do
       Route.routes.first.should == app_home_route
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_taster
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -339,6 +339,7 @@ files:
 - spec/dummy/tmp/cache/sass/f455898439b6313d4297be03fbcfa4df713cf294/_bootstrap.scssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/bootstrap.min.cssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/layout.css.scssc
+- spec/dummy/tmp/pids/server.pid
 homepage: https://github.com/fredwu/api_taster
 licenses: []
 post_install_message: 
@@ -353,7 +354,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1174127571206954277
+      hash: 2450223208085472037
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -362,7 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1174127571206954277
+      hash: 2450223208085472037
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -500,6 +501,7 @@ test_files:
 - spec/dummy/tmp/cache/sass/f455898439b6313d4297be03fbcfa4df713cf294/_bootstrap.scssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/bootstrap.min.cssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/layout.css.scssc
+- spec/dummy/tmp/pids/server.pid
 - spec/form_builder_spec.rb
 - spec/mapper_spec.rb
 - spec/route_spec.rb