pact-support 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWE0OThiMTk0ZTVjOTU1YWE5MGZmODZiZDM2MjIzNTc3M2YwYTZhYw==
-  data.tar.gz: !binary |-
-    NGE1ZmFlOGY4M2NjZTUyMTMxODhhYzNkODU0YmU4ZjY2OGNiYWEwMw==
+SHA1:
+  metadata.gz: c22fbc42f806850fdf59aae86c0ab60221e53b31
+  data.tar.gz: d861be0013364c930b5d092caa37fab70a3d9c5c
 SHA512:
-  metadata.gz: !binary |-
-    M2QzYmJlY2M5MzJjMWQwY2RiOTRlNDBhMWRkYTc2MDc4Mjk3MjY4NDIzZWYw
-    Zjc3ODE5OWJhN2JiYzk5MDU0NzI2YWI0Mjg4YmUwMmQ0NjhhZWVmMTEwZDI2
-    NDNlOTYzYjI2NmQ4YWM4YTVlMTQ2NDlmMWFkOTE5OTAzOWVhYWY=
-  data.tar.gz: !binary |-
-    YTBlNGY3YWQ2MzViNjgwNTdiODI2YzM0MzNiMGJiOTAxNTkyOTVmNzAzZTQw
-    OWY4YTA5YTAwYmZjNTZhZWQ4MmU3Y2NkZmNlNjJkZjcxYWUyNWY4NmUxNzY3
-    ODFkODcxNjkxYjZiZjhkNTFmZTJlOWM0NThjZDAyYTEzZGUyMWI=
+  metadata.gz: ce97bbeb237b4ed9dd74251120aab5a1ad6a452057c0fdf4f7236c811fe35a944bc3a89263983782bbc304104ea2e2f36b37a2b40c0455cf8c647ad26e0c249e
+  data.tar.gz: 92b643e2648be79ccf6e7221d7d3a30e3a735fe6cc04f0cede398a7ac6bc720a3d0564d8da9ade013003d616c87b39ae1bff815bb7d8dbb5346f8cb3764b4d0c

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 0.0.3 (17 October 2014)
+
+* bab0b34 - Added possibility to provide queries as Hash. Then order of parameters in the query is not longer relevant. (André Allavena, Tue Oct 14 00:24:38 2014 +1000)
+
 ### 0.0.2 (12 October 2014)
 
   * e7080fe - Added a QueryString class in preparation for a QueryHash class (Beth, Sun Oct 12 14:32:15 2014 +1100)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact-support (0.0.2)
+    pact-support (0.0.3)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
@@ -46,7 +46,7 @@ GEM
       rspec-core (~> 3.1.0)
       rspec-expectations (~> 3.1.0)
       rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.6)
+    rspec-core (3.1.7)
       rspec-support (~> 3.1.0)
     rspec-expectations (3.1.2)
       diff-lcs (>= 1.2.0, < 2.0)

data/lib/pact/consumer_contract/query.rb

@@ -0,0 +1,16 @@
+require_relative 'query_hash'
+require_relative 'query_string'
+
+module Pact
+  class Query
+
+    def self.create query
+      if query.is_a? Hash
+        Pact::QueryHash.new(query)
+      else
+        Pact::QueryString.new(query)
+      end
+    end
+
+  end
+end

data/lib/pact/consumer_contract/query_hash.rb

@@ -0,0 +1,55 @@
+require 'pact/shared/active_support_support'
+require 'pact/matchers'
+require 'pact/symbolize_keys'
+
+module Pact
+  class QueryHash
+
+    include ActiveSupportSupport
+    include Pact::Matchers
+    include SymbolizeKeys
+
+    def initialize query
+      @hash = query.nil? ? query : convert_to_hash_of_arrays(query)
+    end
+
+    def convert_to_hash_of_arrays query
+      symbolize_keys(query).inject({}) {|h,(k,v)|  h[k] = v.is_a?(Array) ? v : [v] ; h }
+    end
+
+    def as_json opts = {}
+      @hash
+    end
+
+    def to_json opts = {}
+      as_json(opts).to_json(opts)
+    end
+
+    def eql? other
+      self == other
+    end
+
+    def == other
+      QueryHash === other && other.query == query
+    end
+
+    # other will always be a QueryString, not a QueryHash, as it will have ben created
+    # from the actual query string.
+    def difference(other)
+      diff(query, symbolize_keys(CGI::parse(other.query)))
+    end
+
+    def query
+      @hash
+    end
+
+    def to_s
+      @hash.inspect
+    end
+
+    def empty?
+      @hash && @hash.empty?
+    end
+
+  end
+end

data/lib/pact/reification.rb

@@ -1,30 +1,38 @@
 require 'randexp'
-
+require 'rack/utils'
+# reqiore 'active_support/core_ext/object/to_param'
 module Pact
   module Reification
+    include ActiveSupportSupport
 
     def self.from_term(term)
       case term
       when Pact::Term, Regexp, Pact::SomethingLike
-        term.generate
+      term.generate
       when Hash
         term.inject({}) do |mem, (key,term)|
           mem[key] = from_term(term)
-        mem
-        end
-      when Array
-        term.inject([]) do |mem, term|
-          mem << from_term(term)
           mem
         end
+      when Array
+        term.map{ |t| from_term(t)}
       when Pact::Request::Base
         from_term(term.to_hash)
       when Pact::QueryString
         from_term(term.query)
+        when Pact::QueryHash
+        term.query.map { |k, v|
+          if v.nil?
+            k
+          elsif v.is_a?(Array) #For cases where there are multiple instance of the same parameter
+            v.map { |x| "#{k}=#{from_term(x)}"}.join('&')
+          else
+            "#{k}=#{from_term(v)}"
+          end
+        }.join('&')
       else
         term
       end
     end
-
   end
 end

data/lib/pact/shared/request.rb

@@ -1,7 +1,7 @@
 require 'pact/matchers'
 require 'pact/symbolize_keys'
 require 'pact/consumer_contract/headers'
-require 'pact/consumer_contract/query_string'
+require 'pact/consumer_contract/query'
 
 module Pact
 
@@ -19,7 +19,7 @@ module Pact
         @path = path.chomp('/')
         @headers = Hash === headers ? Headers.new(headers) : headers # Could be a NullExpectation - TODO make this more elegant
         @body = body
-        @query = is_unspecified?(query) ? query : Pact::QueryString.new(query)
+        @query = is_unspecified?(query) ? query : Pact::Query.create(query)
       end
 
       def to_json(options = {})

data/lib/pact/support/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Support
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/lib/pact/consumer_contract/request_spec.rb

@@ -299,7 +299,117 @@ module Pact
         end
       end
 
-      context "when a string is expected, but a number is found" do
+      context 'when a query is specified' do
+        context 'when the queries are defined by hashes, order does not matter' do
+          let(:expected_query) { { params: 'hello', params2: 'world', params3: 'small' } }
+          let(:actual_query) { 'params3=small&params2=world&params=hello'  }
+
+          it "does match" do
+            expect(subject.matches? actual_request).to be true
+          end
+        end
+
+        context 'when the queries are defined by hashes, order does not matter but content does' do
+          let(:expected_query) { { params: 'hello', params2: 'world', params3: 'small' } }
+          let(:actual_query) { 'params3=big&params2=world&params=hello' }
+
+          it "does not match" do
+            expect(subject.matches? actual_request).to be false
+          end
+        end
+
+        context 'when the queries are defined by hashes, with extra unmatched parameters' do
+          let(:expected_query) { { params: 'hello', params2: 'world', params3: 'small' } }
+          let(:actual_query) { 'params2=world&params=hello' }
+
+          it "does not match" do
+            expect(subject.matches? actual_request).to be false
+          end
+        end
+
+        context 'when the queries are defined by hashes holding Pact Terms, order does not matter but content does' do
+          let(:expected_query) { { params: 'hello', params2: Term.new(generate: 'world', matcher: /w\w+/), params3: 'small' } }
+          let(:actual_query) { 'params3=small&params=hello&params2=wroom'}
+
+          it "does match" do
+            expect(subject.matches? actual_request).to be true
+          end
+        end
+
+        context 'when the queries are defined by hashes holding Pact Terms and the regex does not match' do
+          let(:expected_query) { { params: 'hello', params2: Term.new(generate: 'world', matcher: /w\w+/), params3: 'small' } }
+          let(:actual_query) { 'params3=small&params=hello&params2=bonjour'}
+
+          it "does not match" do
+            expect(subject.matches? actual_request).to be false
+          end
+        end
+
+        context 'when the query is a hash containing arrays, to denote multiple parameters with the same name' do
+          let(:expected_query) {
+            { simple_param: "hi",
+              double_param: ["hello", "world"],
+              simple2: "bye",
+            }
+          }
+          context 'when the multipe terms are in the correct order - order 1' do
+            let(:actual_query) {['simple_param=hi', 'double_param=hello', 'double_param=world', 'simple2=bye'].join('&')}
+            it "does match" do
+              expect(subject.matches? actual_request).to be true
+            end
+          end
+          context 'when the multipe terms are in the correct order - order 2' do
+            let(:actual_query) {['simple_param=hi', 'double_param=hello', 'simple2=bye', 'double_param=world'].join('&')}
+            it "does match" do
+              expect(subject.matches? actual_request).to be true
+            end
+          end
+          context 'when the multipe terms are in the correct order - order 3' do
+            let(:actual_query) {['simple2=bye', 'double_param=hello', 'double_param=world', 'simple_param=hi'].join('&')}
+            it "does match" do
+              expect(subject.matches? actual_request).to be true
+            end
+          end
+          context 'when the multiple terms are in incorrect order' do
+            let(:actual_query) {['simple2=bye', 'double_param=world', 'double_param=hello', 'simple_param=hi'].join('&')}
+            it "does not match" do
+              expect(subject.matches? actual_request).to be false
+            end
+          end
+          context 'when the first of the multiple terms is missing' do
+            let(:actual_query) {['simple_param=hi', 'double_param=world', 'simple2=bye', ].join('&')}
+            it "does not match" do
+              expect(subject.matches? actual_request).to be false
+            end
+          end
+          context 'when the last of the multiple terms is missing' do
+            let(:actual_query) {['simple_param=hi', 'double_param=hello', 'simple2=bye', ].join('&')}
+            it "does not match" do
+              expect(subject.matches? actual_request).to be false
+            end
+          end
+        end
+
+        context 'when the query does not contain multiple params of the same name, but the request does' do
+          let(:expected_query) { {param1: 'hi', param2: 'there'} }
+          context 'when the param is duplicated' do
+            let(:actual_query) { 'param1=hi&param2=there&param2=there'}
+            it "does not match" do
+              expect(subject.matches? actual_request).to be false
+            end
+          end
+          context 'when the duplicated param has different values' do
+            let(:actual_query) { 'param1=hi&param2=there&param2=overthere' }
+            it "does not match" do
+              expect(subject.matches? actual_request).to be false
+            end
+          end
+        end
+      end
+
+
+
+      context "when in the body a string is expected, but a number is found" do
         let(:actual_body) { { thing: 123} }
         let(:expected_body) { { thing: "123" } }
 

data/spec/lib/pact/reification_spec.rb

@@ -75,5 +75,39 @@ module Pact
 
     end
 
+    context "when Hash Query" do
+
+      subject { Reification.from_term(query)}
+
+      let(:query) { QueryHash.new( {param: 'hello', extra: 'world'})}
+
+      it "returns the hash in the natural order" do
+        expect(subject).to eq("param=hello&extra=world")
+      end
+    end
+
+    context "when Hash Query with embeded terms" do
+
+      subject { Reification.from_term(query)}
+
+      let(:query) { QueryHash.new( {param: 'hello', extra: Pact::Term.new(generate: "wonderworld", matcher: /\w+world/)})}
+
+      it "returns the hash in the natural order, and fills in Terms appropriately" do
+        expect(subject).to eq("param=hello&extra=wonderworld")
+      end
+
+    end
+    context "when Hash Query with Arrays and multiple params with the same name" do
+
+      subject { Reification.from_term(query)}
+
+      let(:query) { QueryHash.new( {param: 'hello', double: [Pact::Term.new(generate: "wonder", matcher: /\w+/), 'world'], simple: 'bye'})}
+
+      it "returns the hash in the natural order, and fills in Terms appropriately" do
+        expect(subject).to eq("param=hello&double=wonder&double=world&simple=bye")
+      end
+
+    end
+
   end
 end

data/spec/lib/pact/shared/request_spec.rb

@@ -42,6 +42,13 @@ module Pact
           end
         end
 
+        context "with a query that is a hash" do
+          let(:query) { { params: 'hello', params2: Term.new(generate: 'world', matcher: /w\w+/), params3: 'small' }  }
+          it "appends the query" do
+            expect(subject).to eq("/something?params=hello&params2=world&params3=small")
+          end
+        end
+
         context "with an empty query" do
           let(:query) { "" }
           it "does include a query" do

data/spec/support/shared_examples_for_request.rb

@@ -41,6 +41,39 @@ shared_examples "a request" do
         expect(subject.full_path).to eq "/path?a"
       end
     end
+    context "with a path and a query that is a QueryString" do
+      subject { described_class.from_hash({:path => '/path', :method => 'get', :headers => {}, :query => Pact::Term.new(generate: 'a', matcher: /a/)}) }
+      it "returns the full path with reified path" do
+        expect(subject.full_path).to eq "/path?a"
+      end
+    end
+    context "with a path and a query that is a QueryHash" do
+      subject { described_class.from_hash({:path => '/path', :method => 'get', :headers => {}, :query =>  {param: 'hello', extra: 'world'}}) }
+      it "returns the full path with reified path" do
+        expect(subject.full_path).to eq "/path?param=hello&extra=world"
+      end
+    end
+    context "with a path and a query that is a QueryHash with an embeded Term" do
+      subject { described_class.from_hash({:path => '/path', :method => 'get', :headers => {},
+                                           :query =>   {param: 'hello', extra: Pact::Term.new(generate: "wonderworld", matcher: /\w+world/)}}) }
+      it "returns the full path with reified path" do
+        expect(subject.full_path).to eq "/path?param=hello&extra=wonderworld"
+      end
+    end
+    context "with a path and a query that has multiple terms" do
+      subject { described_class.from_hash({:path => '/path', :method => 'get', :headers => {},
+                                           :query =>   {param: 'hello', simple: 'hi', double: [ 'hello', 'world'], last: 'gone'}}) }
+      it "returns the full path with reified path" do
+        expect(subject.full_path).to eq "/path?param=hello&simple=hi&double=hello&double=world&last=gone"
+      end
+    end
+    context "with a path and a query that has multiple terms including terms" do
+      subject { described_class.from_hash({:path => '/path', :method => 'get', :headers => {},
+                                           :query => {param: 'hello', simple: 'hi', double: [ 'hello', Pact::Term.new(generate: "wonderworld", matcher: /\w+world/)], last: 'gone'}}) }
+      it "returns the full path with reified path" do
+        expect(subject.full_path).to eq "/path?param=hello&simple=hi&double=hello&double=wonderworld&last=gone"
+      end
+    end
   end
 
   describe "building from a hash" do
@@ -71,10 +104,15 @@ shared_examples "a request" do
       expect(subject.body).to eq 'hello mallory'
     end
 
-    it "extracts the query" do
+    it "extracts the string query" do
       expect(subject.query).to eq Pact::QueryString.new('query')
     end
 
+    it "extracts the hash query" do
+      raw_request['query']= {param: 'hello', extra: 'world'}
+      expect(subject.query).to eq Pact::QueryHash.new( {param: 'hello', extra: 'world'})
+    end
+
     it "blows up if method is absent" do
       raw_request.delete 'method'
       expect { described_class.from_hash(raw_request) }.to raise_error
@@ -91,4 +129,4 @@ shared_examples "a request" do
     end
 
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-support
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -32,14 +32,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
@@ -74,14 +74,14 @@ dependencies:
   name: json
   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
@@ -116,14 +116,14 @@ dependencies:
   name: thor
   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
@@ -158,14 +158,14 @@ dependencies:
   name: pry
   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'
 - !ruby/object:Gem::Dependency
@@ -200,14 +200,14 @@ dependencies:
   name: activesupport
   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: 
@@ -238,6 +238,8 @@ files:
 - lib/pact/consumer_contract/headers.rb
 - lib/pact/consumer_contract/interaction.rb
 - lib/pact/consumer_contract/pact_file.rb
+- lib/pact/consumer_contract/query.rb
+- lib/pact/consumer_contract/query_hash.rb
 - lib/pact/consumer_contract/query_string.rb
 - lib/pact/consumer_contract/request.rb
 - lib/pact/consumer_contract/response.rb
@@ -338,17 +340,17 @@ 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.1.11
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Shared code for Pact gems