roar 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c60a365b03b4c4196033eccc186b649c50f8f40a
-  data.tar.gz: 4e5dfbfe2caa91f334c2568d6a563c223776cdab
+SHA256:
+  metadata.gz: a6cecfd29cd502ae30718cbf9b8ca3a5befc380b0af976b547eafa0f70cfeae3
+  data.tar.gz: dbb230511da49e696f96259bc46f89a2f401f6cbe954dbe1f3c5768f4c65dbc2
 SHA512:
-  metadata.gz: f2ea14d0d3b644f2f0f4c0677e35419a91955e97f6357a283a2f21206c19a35fd19ef8c166f3b4540449fc09cf3c70ab54688c4266bfca1aa00c2a33bf6e3769
-  data.tar.gz: ee6b42fc8b33f3e21955d6ee4ba658a4903503c4208cfc766017123ddceb802a906c759a845dbe9e9a202cd3465f0ad9db5e1c835a61adeb420a2f4308a0d07b
+  metadata.gz: ef524e4b90b8cc57a6d36aedf89d4e378f08239e07344da0de0132e9aee99c27bbe885f16eaa3e8322158d23557e25b8bc507bbc3f5cf9e899352829fad299b7
+  data.tar.gz: e0316e4a6dd737d12df3dffda56996cd7f1c915d67b1c771f5c633de541869bce3d4e2077d529a27ef5c107d30e2cb741834e717769e72e183fe6222c5eadab3

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,20 @@
+Note: If you have a question about Roar, would like help using
+Roar, want to request a feature, or do anything else other than
+submit a bug report, please use the Trailblazer gitter channel.
+
+### Complete Description of Issue
+
+
+### Steps to reproduce
+
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### System configuration
+**Roar version**:
+
+### Full Backtrace of Exception (if any)

data/.travis.yml

@@ -1,11 +1,16 @@
-rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
-  - rbx-2
-gemfile:
-  - gemfiles/Gemfile.representable-2.0
-  - gemfiles/Gemfile.representable-2.1
-notifications:
-  irc: "irc.freenode.org#cells"
+language: ruby
+before_install:
+  - gem install bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+  include:
+    - rvm: 2.3.8
+    - rvm: 2.4.6
+    - rvm: 2.5.5
+    - rvm: 2.6.3
+    - rvm: jruby-9.1.15.0
+      env:
+        - JRUBY_OPTS="--client -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-Xss2m -Xcompile.invokedynamic=false -J-Xmx1536m"
+    - rvm: ruby-head

data/CHANGES.markdown

@@ -1,3 +1,25 @@
+# 1.1.1
+
+* Allow Representable 3.x.
+
+# 1.1.0
+
+* Require Representable 3.0.x
+* Remove CollectionJSON support until we get more feedback.
+* Move JSON API support (`Roar::JSON::JSONAPI`) to the separate [roar-jsonapi](https://github.com/trailblazer/roar-jsonapi) gem.
+* When using `links[]`, you now need to provide the string name, as in `decorator.links["self"]`. Symbols are not supported, anymore.
+* `::links` now accepts a String or Symbol as its first argument, enabling more straight-forward definition of CURIE links: e.g. `links 'doc:link_collection' do; end` (@edejong).
+* Clients can now parse lonely collections. (@hilary)
+
+
+# 1.0.4
+
+* Require Representable < 2.4.
+
+# 1.0.3
+
+* Make `:as` work with `HAL`.
+
 # 1.0.2
 
 * Roar runs on Rubinius.
@@ -9,7 +31,7 @@
 
 # 1.0.1
 
-* Allow calling `::has_one`, `::links` and `::has_many` in any order in JSON-API. This requires representable >= 2.1.4.
+* Allow calling `::has_one`, `::links` and `::has_many` in any order in JSON API. This requires Representable >= 2.1.4.
 
 # 1.0.0
 
@@ -23,25 +45,24 @@
 
 ## Added
 
-* `Roar::JSON::JSONAPI` supports JSON-API. A big thanks to @oliverbarnes for his continous help, support and research on how to implement this standard.
-
+* `Roar::JSON::JSONAPI` supports JSON API. A big thanks to @oliverbarnes for his continuous help, support and research on how to implement this standard.
 
 ## Relevant
 
 * `Hyperlink#to_hash` now returns stringified keys.
 * Removed `Representer#before_serialize` hook. Override `#serialize` yourself.
-* Represented#links now returns `nil` when no parsing has happened.
+* `Represented#links` now returns `nil` when no parsing has happened.
 * Removed class methods `::from_json`, `::from_hash`, `::from_xml` and `::deserialize`. Please build the instance yourself and use something along `Song.new.from_json`.
 
 ## Internals
 
-* Remove the concept of ´links_array`. `Hyperlink` instances for rendering or that have been parsed are always stored in a `LinkCollection` that is available via `#links`.
+* Remove the concept of `links_array`. `Hyperlink` instances for rendering or that have been parsed are always stored in a `LinkCollection` that is available via `#links`.
 * `Hypermedia` is now 43% simpler.
 * `HyperlinkCollection#each` now has different semantics for 1- or 2-arity.
 
 # 0.12.8
 
-* Last release to support representable < 2.0.
+* Last release to support Representable < 2.0.
 
 # 0.12.7
 
@@ -49,11 +70,11 @@
 
 # 0.12.6
 
-* Remove deprecations (most of 'em) from representable-1.8. Sorry for that.
+* Remove deprecations (most of 'em) from Representable 1.8. Sorry for that.
 
 # 0.12.5
 
-* Roar runs with representable <= 1.8.
+* Roar runs with Representable <= 1.8.
 
 # 0.12.4
 
@@ -71,23 +92,22 @@
 * They now yield the request object to add headers etc before request is sent.
 * They NO LONGER support positional arguments but one hash with `uri: "https://roar.de", body:, .. as: ..` and so on.
 
-
 # 0.12.2
 
 * Fix a bug where hyperlinks from nested objects weren't rendered in XML.
 
 # 0.12.1
 
-Allow representable >= 1.6.
+Allow Representable >= 1.6.
 
 # 0.11.18
 
-* Updating to representable-1.5.2.
+* Updating to Representable 1.5.2.
 
 # 0.11.17
 
 * Fixing HAL + Decorator.
-* Requiring representable-1.5.0.
+* Requiring Representable 1.5.0.
 
 # 0.11.16
 
@@ -95,15 +115,15 @@ Allow representable >= 1.6.
 
 # 0.11.15
 
-* Fixing [#66](https://github.com/apotonick/roar/issues/66).
+* Fixing [#66](https://github.com/trailblazer/roar/issues/66).
 
 # 0.11.14
 
-* Fixing Gemfile.
+* Fixing `Gemfile`.
 
 # 0.11.13
 
-* Adding `Roar::Decorator`, see [representable docs](https://github.com/apotonick/representable#decorator-vs-extend) for now.
+* Adding `Roar::Decorator`, see [Representable docs](https://github.com/apotonick/Representable#decorator-vs-extend) for now.
 
 # 0.11.12
 
@@ -113,104 +133,113 @@ Allow representable >= 1.6.
 
 * Allow use of `::link(string)`.
 
-## 0.11.10
+# 0.11.10
 
 * Fix a syntax error for Ruby 1.8.
-* Store link definitions in `representable_attrs(:links)` now and no longer in the `LinksDefinition` instance itself. removing `#links_definition` in favor of `#link_configs`.
+* Store link definitions in `Representable_attrs(:links)` now and no longer in the `LinksDefinition` instance itself. removing `#links_definition` in favor of `#link_configs`.
 
-## 0.11.9
+# 0.11.9
 
 * When using `Feature::Client` hyperlinks are no longer rendered in POST and PUT since we pass `links: false`.
 * `Transport::NetHttp` now sets both `Accept:` and `Content-type:` header since Rails services seems to get confused.
 
-## 0.11.8
+# 0.11.8
 
 * Fixed `JSON::HAL::Links` so that it keys links with `links` and not `_links`. The latter is still done by `JSON::HAL`.
 
-## 0.11.7
+# 0.11.7
 
 * Maintenance release: Fixing the horrible bug fix from 0.11.6 and make it a bit less horrible.
 
-## 0.11.6
+# 0.11.6
 
 * "Fixing" a bug where `links_definition_option` was missing when no link was set in a representer. Note that this is a quick and horrible bugfix and will soon be cleaned up.
 
-## 0.11.5
+# 0.11.5
 
-* Introducing HAL::links method to map arrays of link objects in the HAL format. This completes the HAL/JSON specification.
+* Introducing `HAL::links` method to map arrays of link objects in the HAL format. This completes the HAL/JSON specification.
 
-## 0.11.4
+# 0.11.4
 
 * Links can now return a hash of attributes as `link :self do {:href => fruit_path(self), :title => "Yummy stuff"} end`.
 
-## 0.11.3
+# 0.11.3
 
 * Fixed an installation issue under Windows.
 
-## 0.11.2
+# 0.11.2
 
 * The request body in POST, PUT and PATCH is now actually sent in HttpVerbs. Thanks to @nleguen for finding this embarrassing bug. That's what happens when you don't have proper tests, kids!
 
-## 0.11.1
+# 0.11.1
+
+* Since some users don't have access to my local hard-drive we now really require Representable 1.2.2.
+
+# 0.11.0
 
-* Since some users don't have access to my local hard-drive we now really require representable-1.2.2.
+* Using Representable 1.2.2 now. Be warned that in 1.2 parsing and rendering slightly changed. When a property is not found in the incoming document, it is ignored and thus might not be initialised in your represented model (empty collections are still set to an empty array). Also, the way `false` and `nil` values are rendered changed.
 
-## 0.11.0
+  Quoted from the Representable CHANGES file:
 
-* Using representable-1.2.2 now. Be warned that in 1.2 parsing and rendering slightly changed. When a property is not found in the incoming document, it is ignored and thus might not be initialised in your represented model (empty collections are still set to an empty array). Also, the way `false` and `nil` values are rendered changed. Quoted from the representable CHANGES file:
-* A property with false value will now be included in the rendered representation. Same applies to parsing, false values will now be included. That particularly means properties that used to be unset (i.e. nil) after parsing might be false now.
-* You can include nil values now in your representations since #property respects :represent_nil => true.
+  * A property with false value will now be included in the rendered representation. Same applies to parsing, false values will now be included. That particularly means properties that used to be unset (i.e. nil) after parsing might be false now.
+  * You can include nil values now in your representations since #property respects `:represent_nil => true`.
 
-* The `:except` option got deprecated in favor of `:exclude`.
-* Hyperlinks can now have arbitrary attributes. To render, just provide `#link` with the options
-<code>link :self, :title => "Mee!", "data-remote" => true</code>
-When parsing, the options are avaible via `OpenStruct` compliant readers.
-<code>link = Hyperlink.from_json({\"rel\":\"self\",\"data-url\":\"http://self\"} )
-link.rel #=> "self"
-link.send("data-url") #=> "http://self"
-</code>
+* The `:except` option was deprecated in favor of `:exclude`.
+* Hyperlinks can now have arbitrary attributes.
+  To render, just provide `#link` with the options
 
-## 0.10.2
+  ```ruby
+  link :self, :title => "Mee!", "data-remote" => true
+  ```
+
+  When parsing, the options are available via `OpenStruct` compliant readers.
+
+  ```ruby
+  link = Hyperlink.from_json('{"rel":"self","data-url":"http://self"'})
+  link.rel #=> "self"
+  link.send("data-url") #=> "http://self"
+  ```
+
+# 0.10.2
 
 * You can now pass values from outside to the render method (e.g. `#to_json`), they will be available as block parameters inside `#link`.
 
-## 0.10.1
+# 0.10.1
 
 * Adding the Coercion feature.
 
-## 0.10.0
+# 0.10.0
 
-* Requiring representable-0.1.3.
+* Requiring Representable 0.1.3.
 * Added JSON-HAL support.
 * Links are no longer rendered when `href` is `nil` or `false`.
 * `Representer.link` class method now accepts either the `rel` value, only, or a hash of link attributes (defined in `Hypermedia::Hyperlink.params`), like `link :rel => :self, :title => "You're good" do..`
 * API CHANGE: `Representer#links` no longer returns the `href` value but the link object. Use it like `object.links[:self].href` to retrieve the URL.
 * `#from_json` won't throw an exception anymore when passed an empty json document.
 
-## 0.9.2
+# 0.9.2
 
-* Using representable-1.1.
+* Using Representable 1.1.
 
-## 0.9.1
+# 0.9.1
 
-* Removed @Representer#to_attributes@ and @#from_attributes@.
-* Using representable-1.0.1 now.
+* Removed `Representer#to_attributes` and `#from_attributes`.
+* Using Representable 1.0.1 now.
 
-## 0.9.0
+# 0.9.0
 
-* Using representable-0.12.x.
+* Using Representable 0.12.x.
 * `Representer::Base` is now simply `Representer`.
 * Removed all the class methods from `HttpVerbs` except for `get`.
 
+# 0.8.3
 
-## 0.8.3
-
-* Maintenance release for representable compat.
+* Maintenance release for Representable compat.
 
-## 0.8.2
+# 0.8.2
 
 * Removing `restfulie` dependency - we now use `Net::HTTP`.
 
-## 0.8.1
+# 0.8.1
 
-* Added the :except and :include options to `#from_*`.
+* Added the `:except` and `:include` options to `#from_*`.

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+## How to contribute to Roar
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/trailblazer/roar/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/trailblazer/roar/issues/new). Be sure to follow the issue template.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+* All code in pull requests is assumed to be MIT licensed.  Do not submit a pull request if that isn't the case.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Suggest your change in the [Trailblazer Gitter Room](https://gitter.im/trailblazer/chat) and start writing code.
+
+* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
+
+#### **Do you have questions using Roar?**
+
+* Ask any questions about how to use Roar in the [Trailblazer Gitter Room](https://gitter.im/trailblazer/chat). Github issues are restricted to bug reports and fixes.
+
+* GitHub Issues should not be used as a help forum and any such issues will be closed.
+
+#### **Do you want to contribute to the Roar documentation?**
+
+* Roar documentation is provided via the [Trailblazer site](http://trailblazer.to/gems/roar/) and not the repository readme. Please add your contributions to the [Trailblazer site repository](https://github.com/trailblazer/trailblazer.github.io)

data/Gemfile

@@ -1,7 +1,10 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
+
+ruby RUBY_VERSION
 
-# Specify your gem's dependencies in roar.gemspec
 gemspec
 
-# as long as this is not merged, i'll vendor the runner file.
-# gem "sinatra-contrib", :git => "git@github.com:apotonick/sinatra-contrib.git", :branch => "runner"
+gem "nokogiri", ">= 1.8.5"
+
+gem "minitest-line"
+gem "pry"

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 - 2013 Nick Sutterer and the roar contributors
+Copyright (c) 2011 - 2017 Nick Sutterer and the roar contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the