excon-hypermedia 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 375d919cb0b7562e0664ae44c30d3bdd7b71acf3
-  data.tar.gz: 5d48e0eff3d6f00c2968bb32a330949833a81745
+  metadata.gz: 6c0a3189fb4185c1db3c29a86b699ea1de7549db
+  data.tar.gz: b4d04af297a0ea267d0a2dce0765385bfd5d8483
 SHA512:
-  metadata.gz: cc9e8bfd092cef7babc130b59e8debd50eb84680a37d91da238ec84888ebdae22ea9808035cc324a52ba81833eb67daffb4a5cdd68856fe8c4209bb5d0ca5d77
-  data.tar.gz: 080f93835dba3d7648c37377293428dadaf1e60281511f8d014debf4dacb5f65555cb96de919461229c718fa0fa253481275a4beff9f9b383d0888184d9c0c56
+  metadata.gz: f7576259b25677acc8f9b23171705babafff2bd0510c055723bee712e1f77a329355b090be9544631aabdd199c0e4c068f0818765ffcf1c4abdd5f03a94b004a
+  data.tar.gz: eb29ba745ea6cf03434f3232fd459e7e9bf3db791fba56fc88772e95a10800510f54e5c793e8771df9b77bae240522fd024b305f8bbf5186236d7a0681c815fd

data/README.md

@@ -1,4 +1,4 @@
-# Excon::Hypermedia
+# Excon::Hypermedia [![wercker status](https://app.wercker.com/status/f3fd6cf2045566072ef26354d5a73e9f/s/master "wercker status")](https://app.wercker.com/project/bykey/f3fd6cf2045566072ef26354d5a73e9f)
 
 Teaches [Excon][] how to talk to [HyperMedia APIs][hypermedia].
 
@@ -24,18 +24,13 @@ gem install excon-hypermedia
 
 ## Usage
 
-**NOTE**: This library is in very early development. Right now, it only talks
-the `HAL/JSON` protocol, and it only knows how to follow (non-curie) link
-relations. It returns raw response bodies in string format.
-
-This gem adds a thin layer on top of [Excon][excon] to make it talk with an
-HyperMedia-enabled API. To let Excon know the connection supports HyperMedia,
-simply enable the correct middleware (either globally, or per-connection):
+To let Excon know the API supports HyperMedia, simply enable the correct
+middleware (either globally, or per-connection):
 
 ```ruby
 Excon.defaults[:middlewares].push(Excon::HyperMedia::Middleware)
 
-api = Excon.get('http://www.example.com/api.json')
+api = Excon.get('https://www.example.org/api.json')
 api.class # => Excon::Response
 ```
 
@@ -43,7 +38,7 @@ Using the `HyperMedia` middleware, the `Excon::Response` object now knows how
 to handle the HyperMedia aspect of the API:
 
 ```ruby
-product = api.product(expand: { uid: 'hello' })
+product = api.product(expand: { uid: 'bicycle' })
 product.class # => Excon::Connection
 
 response = product.get
@@ -62,14 +57,47 @@ are available as well:
 product.get(idempotent: true, retry_limit: 6)
 ```
 
-## License
+### Links
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+You can access all links in a resource using the `links` method:
+
+```ruby
+api.links.first.class # => Excon::HyperMedia::Link
+api.links.first.name  # => 'product'
+api.links.first.href  # => 'https://www.example.org/product/{uid}'
+```
 
-## TODO
+You can also access a link directly, using its name:
+
+```ruby
+api.link('product').href # => 'https://www.example.org/product/{uid}'
+```
+
+If you want to access a relation through its link, but can't use the implicit
+naming, you can use the `rel` method:
+
+```ruby
+api.links.last.name # => 'customer-orders'
 
-* make it easy to access attributes in response objects
-* properly handle curied-links and/or non-valid Ruby method name links
+# won't work, due to invalid ruby method name:
+api.customer-orders(expand: { sort: 'desc' }) # => NoMethodError: undefined method `customer' 
+
+# works
+api.rel('customer-orders', expand: { sort: 'desc' })
+```
+
+### Attributes
+
+Attributes are available through the `attributes` method:
+
+```ruby
+product.attributes.to_h # => { uid: 'bicycle', stock: 5 }
+product.attributes.uid  # => 'bicycle'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 [excon]: https://github.com/excon/excon
 [hypermedia]: https://en.wikipedia.org/wiki/HATEOAS

data/excon-hypermedia.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rubocop', '~> 0.40'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'm', '~> 1.5.0'
+  spec.add_development_dependency 'm', '~> 1.5'
 
   spec.add_dependency 'excon', '~> 0.49'
-  spec.add_dependency 'excon-addressable', '~> 0.1'
+  spec.add_dependency 'excon-addressable', '~> 0.2'
 end

data/lib/excon/hypermedia/response.rb

@@ -10,8 +10,6 @@ module Excon
     # requests and attribute values.
     #
     class Response
-      attr_reader :response
-
       def initialize(response)
         @response = response
       end
@@ -21,23 +19,22 @@ module Excon
       # Correctly handle the hypermedia request.
       #
       def handle(method_name, *params)
-        return false if disabled?
-
-        case resource.type?(method_name)
-        when :link      then return handle_link(method_name, params)
-        when :attribute then return handle_attribute(method_name)
+        return false unless enabled?
+
+        if method_name == :rel
+          handle_link(params.shift, params)
+        elsif resource.type?(method_name) == :link
+          handle_link(method_name, params)
+        elsif resource.respond_to?(method_name, false)
+          resource.send(method_name, *params)
+        else
+          false
         end
-
-        respond_to?(method_name) ? send(method_name) : false
       end
 
-      def links
-        resource.links
-      end
+      private
 
-      def attributes
-        resource.attributes
-      end
+      attr_reader :response
 
       def resource
         @resource ||= Resource.new(response.body)
@@ -47,19 +44,9 @@ module Excon
         response.data[:hypermedia] == true
       end
 
-      def disabled?
-        !enabled?
-      end
-
-      private
-
       def handle_link(name, params)
         Excon.new(resource.link(name).href, params.first.to_h.merge(hypermedia: true))
       end
-
-      def handle_attribute(name)
-        attributes[name.to_s]
-      end
     end
   end
 end

data/lib/excon/hypermedia/version.rb

@@ -2,6 +2,6 @@
 
 module Excon
   module HyperMedia
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/test/excon/hypermedia_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # rubocop:disable Metrics/LineLength
 require_relative '../test_helper'
 
@@ -47,6 +48,12 @@ module Excon
       assert response.body.include?('http://www.example.com/hello/world/goodbye{?message}')
     end
 
+    def test_request_using_link
+      response = client.rel('hello', expand: { location: 'world' }).get
+
+      assert response.body.include?('http://www.example.com/hello/world/goodbye{?message}')
+    end
+
     def test_nested_request
       hello    = client.hello(expand: { location: 'world' })
       response = hello.get.goodbye.get
@@ -67,22 +74,22 @@ module Excon
       assert response.body.include?('http://www.example.com/hello/world/goodbye{?message}')
     end
 
-    def test_attribute
+    def test_links
       response = client.hello(expand: { location: 'world' }).get
 
-      assert_equal response.uid, 'hello'
-      assert_equal response.message, 'goodbye!'
+      assert_equal response.links.first.name, 'goodbye'
     end
 
-    def test_links
+    def test_link
       response = client.hello(expand: { location: 'world' }).get
 
-      assert_equal response.links.first.name, 'goodbye'
+      assert_equal response.link('goodbye').name, 'goodbye'
     end
 
     def test_attributes
       response = client.hello(expand: { location: 'world' }).get
 
+      assert_equal response.attributes.to_h, uid: 'hello', message: 'goodbye!'
       assert_equal response.attributes.uid, 'hello'
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon-hypermedia
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 description: Excon, with Hypermedia traversing baked in.
 email:
 - jean@mertz.fm