apill 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19fd91487d72b0958cf639a9eaa44435a0519f20
-  data.tar.gz: fbd7296da9eee162e7eade29bcdb39fd91521546
+  metadata.gz: ac63789c44dc822312c6aebd4c12726fcd4d4810
+  data.tar.gz: eb5660a665df63b8e1149685cdd6e2d92f455298
 SHA512:
-  metadata.gz: 892892befdf4a720ca7fedbb59b1934607eb0aa2408d577d68eb60f2eead7bf32554852d66074b2a40e5056c965db1910bc34f826e85c0b29c7a4605b9402261
-  data.tar.gz: 8aff948b17818e441c8163bef2d4d3eeb9116b8041099a9e538a6465817bc71cf8d0062d431a6fba23ba539a788bb1e2d1e5a07fd508fa9872c6a3e41f514ad7
+  metadata.gz: 9e8f788f49733b4ac51f389c2041dd6bd7ec2013c000e05fffe721e76de87723aaac8af26485c106bdfa8fdb03eb13258461fc13a93cedf5a26b1015ac785947
+  data.tar.gz: 15c818f83a0e729bb28b4b809cc135a17de8a21ce88f280bbfaaad09e4000ad4d1a7f339737af7aaca4dfdf17f5d67e1466119105c8577bde6325a3b04b73aa8

data/lib/apill/middleware/api_request.rb

@@ -1,4 +1,5 @@
 require 'apill/configuration'
+require 'apill/parameters'
 require 'apill/matchers/subdomain_matcher'
 require 'apill/matchers/accept_header_matcher'
 require 'apill/responses/invalid_api_request_response'
@@ -20,6 +21,8 @@ class   ApiRequest
       if !subdomain_matcher.matches_api_subdomain? ||
           Matchers::AcceptHeaderMatcher.new.matches?(env)
 
+        env['QUERY_STRING'] = Parameters.process(env['QUERY_STRING'])
+
         @app.call(env)
       else
         Responses::InvalidApiRequestResponse.call(env)

data/lib/apill/mixins/pageable.rb

@@ -40,10 +40,10 @@ module  Pageable
 
   def pagination_data
     {
-      total_pages:   @paginated_resource.total_pages,
-      current_page:  @paginated_resource.current_page,
-      previous_page: @paginated_resource.prev_page,
-      next_page:     @paginated_resource.next_page,
+      'total-pages'   => @paginated_resource.total_pages,
+      'current-page'  => @paginated_resource.current_page,
+      'previous-page' => @paginated_resource.prev_page,
+      'next-page'     => @paginated_resource.next_page,
     }
   end
 end

data/lib/apill/parameters.rb

@@ -0,0 +1,21 @@
+module  Apill
+class   Parameters
+  attr_accessor :query_string
+
+  def initialize(query_string)
+    self.query_string = query_string
+  end
+
+  def self.process(query_string)
+    new(query_string).process
+  end
+
+  def process
+    return query_string unless query_string.respond_to? :gsub
+
+    query_string.gsub(/(?<=\A|&|\?)[^=&]+/) do |match|
+      match.gsub!('-', '_')
+    end
+  end
+end
+end

data/lib/apill/serializers/json_api.rb

@@ -0,0 +1,9 @@
+module  Apill
+module  Serializers
+module  JsonApi
+  def type
+    object.class.name.demodulize.tableize.dasherize
+  end
+end
+end
+end

data/lib/apill/version.rb

@@ -1,3 +1,3 @@
 module Apill
-  VERSION = '2.7.1'
+  VERSION = '2.8.0'
 end

data/lib/apill.rb

@@ -10,6 +10,7 @@ require 'apill/mixins/indexable'
 require 'apill/mixins/sortable'
 require 'apill/mixins/queryable'
 require 'apill/mixins/pageable'
+require 'apill/serializers/json_api'
 
 require 'apill/middleware/api_request'
 

data/spec/apill/middleware/api_request_spec.rb

@@ -131,6 +131,25 @@ describe  ApiRequest do
     expect(headers).to  eql({})
     expect(response).to eql 'response'
   end
+
+  it 'converts JSON API compliant dasherized query params to underscored' do
+    app                    = ->(env) { [200, env, 'response'] }
+    api_request_middleware = ApiRequest.new(app)
+
+    request = {
+      'HTTP_HOST'    => 'api.example.com',
+      'HTTP_ACCEPT'  => 'application/vnd.matrix+zion;version=1.0.0',
+      'QUERY_STRING' => 'hello-there=bob-jones&'     \
+                        'nice-to-meet=you-bob&'      \
+                        'hows-the-weather=today-bob',
+    }
+
+    _status, headers, _response = api_request_middleware.call(request)
+
+    expect(headers['QUERY_STRING']).to eql 'hello_there=bob-jones&' \
+                                           'nice_to_meet=you-bob&'  \
+                                           'hows_the_weather=today-bob'
+  end
 end
 end
 end

data/spec/apill/parameters_spec.rb

@@ -0,0 +1,42 @@
+require 'rspectacular'
+require 'apill/parameters'
+
+module    Apill
+describe  Parameters do
+  it 'can underscore the first parameter' do
+    query_params = 'hello-there=bob-jones'
+
+    expect(Parameters.process(query_params)).to eql 'hello_there=bob-jones'
+  end
+
+  it 'can underscore a middle parameter and a parameter at the end' do
+    query_params = 'hello-there=bob-jones&nice-to-meet=you-bob&hows-the-weather=today-bob'
+
+    expect(Parameters.process(query_params)).to eql 'hello_there=bob-jones&'     \
+                                                    'nice_to_meet=you-bob&'      \
+                                                    'hows_the_weather=today-bob'
+  end
+
+  it 'can handle weirdly formatted parameters' do
+    query_params = 'hello-there=bob-jones&nice-to-meet=you-bob&='
+
+    expect(Parameters.process(query_params)).to eql 'hello_there=bob-jones&'     \
+                                                    'nice_to_meet=you-bob&='
+  end
+
+  it 'can handle parameters with no values' do
+    query_params = 'hello-there&nice-to-meet=you-bob&='
+
+    expect(Parameters.process(query_params)).to eql 'hello_there&' \
+                                                    'nice_to_meet=you-bob&='
+  end
+
+  it 'can handle values with no parameter name' do
+    query_params = 'hello-there=bob-jones&=you-bob&nice-to-meet=you-bob&='
+
+    expect(Parameters.process(query_params)).to eql 'hello_there=bob-jones&' \
+                                                    '=you-bob&'              \
+                                                    'nice_to_meet=you-bob&='
+  end
+end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apill
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - jfelchner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: human_error
@@ -89,11 +89,13 @@ files:
 - lib/apill/mixins/pageable.rb
 - lib/apill/mixins/queryable.rb
 - lib/apill/mixins/sortable.rb
+- lib/apill/parameters.rb
 - lib/apill/requests/base.rb
 - lib/apill/requests/rack_request.rb
 - lib/apill/requests/rails_request.rb
 - lib/apill/responses/invalid_api_request_response.rb
 - lib/apill/responses/invalid_subdomain_response.rb
+- lib/apill/serializers/json_api.rb
 - lib/apill/version.rb
 - spec/apill/accept_header_spec.rb
 - spec/apill/errors/invalid_api_request_error_spec.rb
@@ -103,6 +105,7 @@ files:
 - spec/apill/matchers/subdomain_matcher_spec.rb
 - spec/apill/matchers/version_matcher_spec.rb
 - spec/apill/middleware/api_request_spec.rb
+- spec/apill/parameters_spec.rb
 - spec/apill/requests/rack_request_spec.rb
 - spec/apill/requests/rails_request_spec.rb
 homepage: https://github.com/jfelchner/apill
@@ -125,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Common API functionality
@@ -138,5 +141,6 @@ test_files:
 - spec/apill/matchers/subdomain_matcher_spec.rb
 - spec/apill/matchers/version_matcher_spec.rb
 - spec/apill/middleware/api_request_spec.rb
+- spec/apill/parameters_spec.rb
 - spec/apill/requests/rack_request_spec.rb
 - spec/apill/requests/rails_request_spec.rb