hyperclient 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35a0a5739c9ec4a3ba6bc86bba399d2c6ad5a2e2
-  data.tar.gz: 9ed0041d6c5800b897a94b075655729cfb4e0018
+  metadata.gz: c97a980b3d83d85d0f1d2ec0273ce6e01ecb5d7c
+  data.tar.gz: b73b424bd3bc23698d2d1dc6f1c04c1f8b43ba33
 SHA512:
-  metadata.gz: d0ca28cf98b945f26e1f43f39a0bb455bddb9d8312727394fdd75a3a87a81fd2c7bb459d628eec976df99508ad48401ba8f7c82c8892deba68bbd7892803dade
-  data.tar.gz: ad8de8de9a44cfa88b96ed1339a99cc6d574ea26e970e6aad4ff69f8bb3bb0ed45faf2fe10ab9bb23dfefd2177a151f0d8f47770af901f7981b4bd6e4d70784d
+  metadata.gz: 81931fcf7209cc55227b6578b7588c86a94883d02b53cdf0cfe3b09e798e331e7bbe415aaa5b3c162e08a361ea115765b3e9d02c66f13324780a17c79d4a7213
+  data.tar.gz: c7a746bcbe812cd16828915c7457e3474e6848ada0b2f3f58a8f21702fa412f5845951f258758a9af149a8718a2020c649021efe0db214321206f9bec8083dda

data/.travis.yml

@@ -3,7 +3,8 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
-  - rbx-2.2.10
+  - 2.3.0
+  - rbx-2
   - jruby-19mode
   - ruby-head
   - jruby-head
@@ -12,3 +13,7 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: rbx-2
+
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.8.0 (March 15, 2015)
+
+* [#97](https://github.com/codegram/hyperclient/issues/97): Fix: curies are no longer used as link shorteners - [@joshco](https://github.com/joshco), [@dblock](https://github.com/dblock).
+
 ### 0.7.2 (August 23, 2015)
 
 * [#95](https://github.com/codegram/hyperclient/issues/95): Fix: re-add eager delegation for `resource.x._embeddded.x` - [@dblock](https://github.com/dblock).

data/README.md

@@ -127,10 +127,11 @@ The client is responsible for supplying all the necessary parameters. Templated
 
 ### Curies
 
-Curies are named tokens that you can define in the document and use to express curie relation URIs in a friendlier, more compact fashion. For example, the demo API contains very long links to images that use an "images" curie. Hyperclient handles curies and resolves these into full links automatically.
+Curies are a suggested means by which to link documentation of a given resource. For example, the demo API contains very long links to images that use an "images" curie.
 
 ```ruby
 puts spline['image:thumbnail'] # => https://grape-with-roar.herokuapp.com/api/splines/uuid/images/thumbnail.jpg
+puts spline.links._curies['image'].expand('thumbnail') # => /docs/images/thumbnail
 ```
 
 ### Attributes

data/UPGRADING.md

@@ -1,6 +1,50 @@
 Upgrading Hyperclient
 =====================
 
+### Upgrading to >= 0.8.0
+
+### Changes in curies
+
+Previous versions of Hyperclient misinterpreted the HAL RFC and used curies as if they were designed to enable compact URIs. Curies in HAL are provided for documentation purposes.
+
+Since version 0.8.0 they are no longer expanded. Consider the following example.
+
+```json
+{
+  "_links": {
+    "self": { "href": "/orders" },
+    "curies": [{
+      "name": "acme",
+      "href": "http://docs.acme.com/relations/{rel}",
+      "templated": true
+    }],
+    "acme:widgets": { "href": "/widgets" }
+  }
+}
+```
+
+```rb
+client = Hyperclient.new('http://example.org/api')
+
+client._links["acme:widgets"]
+
+# before
+# => "http://docs.acme.com/relations/widgets"
+
+# after
+# => "http://example.org/api/widgets"
+```
+
+In addition, you can now access and expand the curie.
+
+```rb
+curie = client._links._curies["acme"]
+curie.expand('widgets')
+# => "http://docs.acme.com/relations/widgets"
+```
+
+See [#97](https://github.com/codegram/hyperclient/issues/97) for more information.
+
 ### Upgrading to >= 0.7.0
 
 #### Changes in default headers

data/lib/hyperclient/link_collection.rb

@@ -11,6 +11,8 @@ module Hyperclient
   #   resource.links.author
   #
   class LinkCollection < Collection
+    attr_reader :_curies
+
     # Public: Initializes a LinkCollection.
     #
     # collection  - The Hash with the links.
@@ -19,13 +21,13 @@ module Hyperclient
     def initialize(collection, curies, entry_point)
       fail "Invalid response for LinkCollection. The response was: #{collection.inspect}" if collection && !collection.respond_to?(:collect)
 
-      @curies = (curies || {}).reduce({}) do |hash, curie_hash|
+      @_curies = (curies || {}).reduce({}) do |hash, curie_hash|
         curie = build_curie(curie_hash, entry_point)
         hash.update(curie.name => curie)
       end
 
       @collection = (collection || {}).reduce({}) do |hash, (name, link)|
-        hash.update(name => build_link(name, link, @curies, entry_point))
+        hash.update(name => build_link(name, link, @_curies, entry_point))
       end
     end
 
@@ -46,10 +48,6 @@ module Hyperclient
         link_or_links.map do |link|
           build_link(name, link, curies, entry_point)
         end
-      elsif (curie_parts = /(?<ns>[^:]+):(?<short_name>.+)/.match(name))
-        curie = curies[curie_parts[:ns]]
-        link_or_links['href'] = curie.expand(link_or_links['href']) if curie
-        Link.new(name, link_or_links, entry_point)
       else
         Link.new(name, link_or_links, entry_point)
       end

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = '0.7.2'
+  VERSION = '0.8.0'
 end

data/test/fixtures/element.json

@@ -18,13 +18,13 @@
         "curies" : [
             {
               "name": "image",
-              "href": "/images/{rel}",
+              "href": "/docs/images/{rel}",
               "templated": true
             }
         ],
         "null_link": null,
         "image:thumbnail": {
-          "href": "thumbnails/{version}.jpg",
+          "href": "/images/thumbnails/{version}.jpg",
           "templated": true
         }
     },

data/test/hyperclient/curie_test.rb

@@ -23,12 +23,17 @@ module Hyperclient
     end
 
     let(:curie) do
-      Curie.new({ 'name' => 'image', 'href' => '/images/{?rel}', 'templated' => true }, entry_point)
+      Curie.new({ 'name' => 'image', 'href' => '/images/{rel}', 'templated' => true }, entry_point)
     end
     describe '_name' do
       it 'returns curie name' do
         curie.name.must_equal 'image'
       end
     end
+    describe 'expand' do
+      it 'expands link' do
+        curie.expand('thumbnail').must_equal '/images/thumbnail'
+      end
+    end
   end
 end

data/test/hyperclient/link_collection_test.rb

@@ -46,9 +46,13 @@ module Hyperclient
 
     describe 'curied link collection' do
       let(:curied_link) { links['image:thumbnail'] }
+      let(:curie) { links._curies['image'] }
       it 'must expand' do
         curied_link._expand(version: 'small')._url.must_equal '/images/thumbnails/small.jpg'
       end
+      it 'exposes curie' do
+        curie.expand('thumbnail').must_equal '/docs/images/thumbnail'
+      end
     end
 
     describe 'array of links' do

metadata

@@ -1,195 +1,195 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Oriol Gual
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-23 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   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
   name: futuroscope
   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
   name: faraday_middleware
   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
   name: faraday_hal_middleware
   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
   name: uri_template
   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
   name: net-http-digest_auth
   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
   name: faraday-digestauth
   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
   name: minitest
   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
   name: turn
   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
   name: webmock
   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
   name: mocha
   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
   name: rack-test
   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
   name: spinach
   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: HyperClient is a Ruby Hypermedia API client.
@@ -199,11 +199,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- ".yardopts"
+- .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
+- .yardopts
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -256,17 +256,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.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ''