excon-addressable 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fb78674bba0eea1c3c0375e89057353d0a0ab2c
-  data.tar.gz: 7d7fbe6b86458feeb6d4df55607060c2d2741205
+  metadata.gz: 90173753b01163b519a0566df85dbc5118c6adbd
+  data.tar.gz: 4693cef069140939f66b2ce2ee2b4932b1986f58
 SHA512:
-  metadata.gz: 5ea5018b4786f5c980043e760d0a4fc2ee358de76d6fa188168aae6625eab58d82159d43b92294c737bcbb5d8b584a0a9d3ea9bfd8be3bdfc475b72a6bd32bc5
-  data.tar.gz: 350853bfb125a5b8fb56b737b78fd67a8ce5bb6908eccf3092bce45aee830c58b5a492beb8b1ff9c846c16fe123d637d7197bd5d015a23aeb347fa1970e20d16
+  metadata.gz: f09281bfad34455f3d6c9f2a0ac469df5c8adcc4135872a7bdaebb4ef4bccbd95a1e09929dc3938a5a43e9ae97a876a844137633d342961dc08fd0fdcaf2581f
+  data.tar.gz: 7bafb1b96ae0214c30107c1ad61f717f9b44817c2be7d8a229977988d4526165bf4459db151a5379e721e67428dacf521a90073bba9b7ca354feea4843f2f1fb

data/README.md

@@ -1,6 +1,7 @@
 # Excon::Addressable [![wercker status](https://app.wercker.com/status/3868c162aa140566b830f517c45d528a/s/master "wercker status")](https://app.wercker.com/project/bykey/3868c162aa140566b830f517c45d528a)
 
-Sets [Addressable][] as the default URI parser. Supports parsing [templated uris][].
+Sets [Addressable][addressable] as the default URI parser. Supports parsing
+[templated uris][].
 
 ## Installation
 
@@ -12,14 +13,29 @@ gem 'excon-addressable'
 
 And then execute:
 
-    $ bundle
+```shell
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install excon-addressable
+```shell
+gem install excon-addressable
+```
 
 ## Usage
 
+Be sure to add `Excon::Addressable::Middleware` to the top of the middleware
+stack, so that the variables get expanded as early as possible. This prevents
+other middleware from choking on non-valid URIs.
+
+```ruby
+Excon.defaults[:middlewares].unshift(Excon::Addressable::Middleware)
+```
+
+Then simply provide a templated variable, and the values with which to expand
+the template:
+
 ```ruby
 conn = Excon.new('http://www.example.com/{uid}', expand: { uid: 'hello' })
 conn.request.path # => '/hello'
@@ -29,5 +45,5 @@ conn.request.path # => '/hello'
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-[Addressable]: https://github.com/sporkmonger/addressable
+[addressable]: https://github.com/sporkmonger/addressable
 [templated uris]: https://github.com/sporkmonger/addressable#uri-templates

data/lib/excon/addressable/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Excon
   module Addressable
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/excon/addressable.rb

@@ -5,19 +5,23 @@ require 'excon/addressable/version'
 
 Excon.defaults[:uri_parser] = Addressable::URI
 
-# :nodoc:
 module Excon
-  # Addressable addition to Excon.
-  #
   module Addressable
-    def new(url, params = {})
-      if (template = ::Addressable::Template.new(url)) && template.variables.any?
-        url = template.expand(params.delete(:expand).to_h)
-      end
+    # Middleware
+    #
+    # Parses a Templated URI string and merges it with the provided variables.
+    #
+    class Middleware < Excon::Middleware::Base
+      def request_call(datum)
+        url = ::Addressable::URI.new(datum)
+
+        if (template = ::Addressable::Template.new(url)) && template.variables.any?
+          uri = template.expand(datum[:expand].to_h)
+          datum.merge!(uri.to_hash)
+        end
 
-      super
+        super
+      end
     end
   end
-
-  singleton_class.prepend Addressable
 end

data/test/excon/addressable_test.rb

@@ -8,21 +8,46 @@ module Excon
   #
   class AddressableTest < Minitest::Test
     def setup
+      Excon.defaults[:middlewares].unshift(Excon::Addressable::Middleware)
       Excon.defaults[:mock] = true
-      Excon.stub({}, status: 200)
+      Excon.stub({ path: '/' }, body: 'index')
+      Excon.stub({ path: '/hello' }, body: 'world')
+      Excon.stub({ path: '/hello', query: 'message=world' }, body: 'hi!')
+      Excon.stub({ path: '/world' }, body: 'universe')
     end
 
     def test_expand_templated_uri
-      conn = Excon.new('http://www.example.com/{uid}', expand: { uid: 'hello' })
+      connection = Excon.new('http://www.example.com/{uid}', expand: { uid: 'hello' })
+      response   = connection.get
 
-      assert_equal '/hello', conn.data[:path]
-      assert_equal 200, conn.get.status
+      assert_equal 'world', response.body
     end
 
     def test_templated_uri_with_optional_query_parameters
-      conn = Excon.new('http://www.example.com/{?uid}')
+      connection = Excon.new('http://www.example.com/{?uid}')
+      response   = connection.get
 
-      assert_equal '/', conn.data[:path]
+      assert_equal 'index', response.body
+    end
+
+    def test_templated_uri_with_excon_shortcut_method
+      response = Excon.get('http://www.example.com/{uid}', expand: { uid: 'world' })
+
+      assert_equal 'universe', response.body
+    end
+
+    def test_templated_uri_with_mixed_connection_and_get
+      connection = Excon.new('http://www.example.com/{uid}')
+      response   = connection.get(expand: { uid: 'world' })
+
+      assert_equal 'universe', response.body
+    end
+
+    def test_templated_uri_overriding_variables
+      connection = Excon.new('http://www.example.com/{uid}{?message}', expand: { uid: 'goodbye' })
+      response   = connection.get(expand: { uid: 'hello', message: 'world' })
+
+      assert_equal 'hi!', response.body
     end
 
     def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon-addressable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,4 +154,3 @@ signing_key:
 specification_version: 4
 summary: Excon, with Addressable baked in.
 test_files: []
-has_rdoc: