rspec-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a73666993aeb89c6f6d8256fbd334cf95042c055
-  data.tar.gz: b2c4a007b05a4a00427b169dc1bde8440852243b
+  metadata.gz: c57c8cdc4f5827c53876cb303f2bea89fefae297
+  data.tar.gz: 4ae692036878221cd3d1cadc572f13d5c1b9a913
 SHA512:
-  metadata.gz: 172cff78f4cf2cc300fa1e049975cb80604cccc8aa967156d9363b81cee93ee1321e82d1b68f720678f8ec3abd75c48ae95a87aac93d40049ca20675ae46bd7a
-  data.tar.gz: f380e9efcb009d145b5faa83792be55a4e0a6c527026498318fc99702189af5c94612b32099bcd1546a471b6e39a9632206004a4c472f257fccdeb06f6508d6a
+  metadata.gz: 4f2bc0c289191ddb64a0c936e04c861afeed46516f2e4d00edf609888fcbe8a9cbed8ddad9a9da09f6e1cd9f42bc0f9bcfcd014d59adcc8afc75dd14196e63e6
+  data.tar.gz: 15437e3057b40d9121253bbe42257967943b5455d2655aae305a9674599de50c6a5a30fa735338791ed6fc75e9aba1ac893581e86b470065c782f4cc369d5f19

data/lib/rspec-api/dsl.rb

@@ -10,10 +10,6 @@ def resource(name, args = {}, &block)
   describe name, args, &block
 end
 
-def rspec_api
-  metadata[:rspec_api]
-end
-
 RSpec.configuration.include DSL::Resource, rspec_api_dsl: :resource
 RSpec.configuration.include DSL::Route, rspec_api_dsl: :route
 RSpec.configuration.include DSL::Request, rspec_api_dsl: :request

data/lib/rspec-api/dsl/request.rb

@@ -12,7 +12,7 @@ module DSL
     end
 
     def response_body
-      JSON response.body
+      JSON response_body_without_callbacks
     rescue JSON::ParserError, JSON::GeneratorError
       nil
     end
@@ -58,5 +58,14 @@ module DSL
         has_entity_body?(status_code) && status_code < 400
       end
     end
+
+  private
+
+    def response_body_without_callbacks
+      body = response.body
+      # TODO: extract the 'a_callback' constant
+      callback_pattern = %r[a_callback\((.*?)\)]
+      body =~ callback_pattern ? body.match(callback_pattern)[1] : body
+    end
   end
 end

data/lib/rspec-api/dsl/request/body.rb

@@ -6,6 +6,7 @@ module DSL
 
     module ClassMethods
       def should_match_body_expectations(status_code, &block)
+        should_return_a_jsonp rspec_api[:callback] if rspec_api[:callback]
         should_return_a_json rspec_api[:array] if success? status_code
         should_include_attributes rspec_api.fetch(:attributes, {}) if success? status_code
         if rspec_api[:array]
@@ -18,6 +19,16 @@ module DSL
 
     private
 
+      def should_return_a_jsonp(callback_options)
+        it {
+          if callback_options[:value] == request_params[callback_options[:name].to_s]
+            expect(response_body).to be_a_jsonp(callback_options[:value])
+          else
+            expect(response_body).to be_a_jsonp(nil)
+          end
+        }
+      end
+
       def should_return_a_json(is_array)
         it { expect(response_body).to be_a_json(is_array ? Array : Hash) }
       end

data/lib/rspec-api/dsl/request/headers.rb

@@ -7,7 +7,7 @@ module DSL
     module ClassMethods
       def should_match_headers_expectations(status_code)
         should_have_json_content_type if has_entity_body? status_code
-        should_be_paginated(rspec_api[:page]) if rspec_api[:array] && rspec_api[:page]
+        should_be_paginated(rspec_api[:page][:name]) if rspec_api[:array] && rspec_api[:page]
       end
 
     private

data/lib/rspec-api/dsl/resource.rb

@@ -3,6 +3,10 @@ module DSL
     extend ActiveSupport::Concern
 
     module ClassMethods
+      def rspec_api
+        metadata[:rspec_api]
+      end
+
       def self.define_action(verb)
         define_method verb do |route, args = {}, &block|
           rspec_api.merge! array: args.delete(:array), verb: verb, route: route
@@ -24,11 +28,11 @@ module DSL
       end
 
       def accepts_page(page_parameter)
-        rspec_api[:page] = page_parameter
+        rspec_api[:page] = {name: page_parameter, value: 2}
       end
 
       def accepts_sort(sort_parameter, options={})
-        rspec_api[:sort] = {parameter: sort_parameter, attribute: options[:on]}
+        rspec_api[:sort] = {name: sort_parameter, attribute: options[:on]}
       end
 
       # TODO: the second 'accepts_filter' should not override the first, but add
@@ -36,6 +40,10 @@ module DSL
         rspec_api[:filter] = options.merge(name: filter_parameter)
       end
 
+      def accepts_callback(callback_parameter)
+        rspec_api[:callback] = {name: callback_parameter, value: 'a_callback'}
+      end
+
     private
 
       def nested_attribute(name)

data/lib/rspec-api/dsl/route.rb

@@ -9,8 +9,8 @@ module DSL
     module ClassMethods
       def request(*args, &block)
         text, values = parse_request_arguments args
-        extra_parameters.each do |params|
-          request_with_extra_params text, values.merge(params), &block
+        sets_of_parameters.each do |params|
+          request_with_params text, values.merge(params), &block
         end
       end
 
@@ -24,7 +24,7 @@ module DSL
 
     private
 
-      def request_with_extra_params(text, values = {}, &block)
+      def request_with_params(text, values = {}, &block)
         context request_description(text, values), rspec_api_dsl: :request do
           # NOTE: Having setup_fixtures inside the context sets up different
           # fixtures for each `request` inside the same `get`. This might be
@@ -38,24 +38,47 @@ module DSL
         end
       end
 
-      def extra_parameters
-        [].tap do |optional_params|
-          optional_params << {} # default: no extra params
+      def sets_of_parameters
+        [].tap do |sets_of_params|
+          sets_of_params.push no_params
+          sets_of_params.push callback_params if rspec_api[:callback]
           if rspec_api[:array]
-            if sort = rspec_api[:sort]
-              optional_params << {sort: sort[:parameter]}
-              optional_params << {sort: "-#{sort[:parameter]}"}
-            end
-            if rspec_api[:page]
-              optional_params << {page: 2}
-            end
-            if filter = rspec_api[:filter]
-              optional_params << {filter[:name] => existing(filter[:on])}
-            end
+            sets_of_params.push sort_params(verse: :asc) if rspec_api[:sort]
+            sets_of_params.push sort_params(verse: :desc) if rspec_api[:sort]
+            sets_of_params.push page_params if rspec_api[:page]
+            sets_of_params.push filter_params if rspec_api[:filter]
           end
         end
       end
 
+      def no_params
+        {} # always send the original request without extra parameters
+      end
+
+      def sort_params(options = {})
+        ascending = options[:verse] == :asc
+        sort = rspec_api[:sort][:name]
+        {sort: ascending ? "#{sort}" : "-#{sort}"}
+      end
+
+      def page_params
+        {}.tap do |params|
+          params[rspec_api[:page][:name]] = rspec_api[:page][:value]
+        end
+      end
+
+      def filter_params
+        {}.tap do |params|
+          params[rspec_api[:filter][:name]] = existing rspec_api[:filter][:on]
+        end
+      end
+
+      def callback_params
+        {}.tap do |params|
+          params[rspec_api[:callback][:name]] = rspec_api[:callback][:value]
+        end
+      end
+
       def setup_request(verb, route, values)
         request = Proc.new {
           interpolated_route, body = route.dup, values.dup

data/lib/rspec-api/matchers.rb

@@ -6,4 +6,5 @@ require_relative 'matchers/attributes'
 require_relative 'matchers/fixtures'
 require_relative 'matchers/page'
 require_relative 'matchers/sort'
-require_relative 'matchers/filter'
+require_relative 'matchers/filter'
+require_relative 'matchers/jsonp'

data/lib/rspec-api/matchers/jsonp.rb

@@ -0,0 +1,17 @@
+RSpec::Matchers.define :be_a_jsonp do |callback_name|
+  match do |response_body|
+    if callback_name.nil?
+      true
+    else
+      response.body =~ %r[^#{callback_name}\((.*?)\)$]
+    end
+  end
+
+  description do
+    %Q(be a JSONP callback)
+  end
+
+  failure_message_for_should do |response_body|
+    %Q(should #{description}, but is #{response_body})
+  end
+end

data/lib/rspec-api/matchers/page.rb

@@ -3,7 +3,7 @@ RSpec::Matchers.define :have_pagination_links do |page|
     if page.nil?
       true
     else
-      links = response_headers['Link'] || '' # https://github.com/lostisland/faraday/pull/306
+      links = response_headers['Link'] || '' # see http://git.io/CUz3-Q
       rels = links.split(',').map{|link| link[/<.+?>; rel="(.*)"$/, 1]}
       rels.sort == ['first', 'prev']
     end
@@ -16,5 +16,4 @@ RSpec::Matchers.define :have_pagination_links do |page|
   failure_message_for_should do |response_headers|
     %Q(should #{description}, but are #{response_headers})
   end
-end
-
+end

data/lib/rspec-api/version.rb

@@ -1,3 +1,3 @@
 module RspecApi
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,7 @@ files:
 - lib/rspec-api/matchers/fields.rb
 - lib/rspec-api/matchers/filter.rb
 - lib/rspec-api/matchers/fixtures.rb
+- lib/rspec-api/matchers/jsonp.rb
 - lib/rspec-api/matchers/page.rb
 - lib/rspec-api/matchers/sort.rb
 - lib/rspec-api/matchers/status.rb