radriar 0.1.0.alpha.2 → 0.1.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57ea1f5b5028c2d60f066bccee36a662244afee1
-  data.tar.gz: bdaacb50e3f2dff27b6dee7fc8193cc1286ea984
+  metadata.gz: a54c46a793a980be7c145a4db67eea542d175390
+  data.tar.gz: 84bf3d6ff4da0701e9a337b2d78897a9b1e5d43f
 SHA512:
-  metadata.gz: 81064a99af29b82f73cdba951a496ff56457bd1e21066c8dd56bffaffc323b06d4f57ffb65def6242c1077d11b837831d4be438b11edc2c3eae2fa5c9ef1e0ec
-  data.tar.gz: 14c0d00e8d89a439a00f8bce1e78bdf3301d39e932c1120086a9cbd2aa52462cd0330101b6245c3d6b4a84f8e889484e79101842304ccef4d690dd37216eeab5
+  metadata.gz: 390ecbeb6f81f2b9593dc47c7b5a2a07363eb31333103a9bcaff63854ac74a839466677f1caa097b8961e0f5476318ee5ec306859427cc2b5d2a1f349811f593
+  data.tar.gz: d74dc28860d958fe14736e4a10bb09e387dd87be6c70b05d3fe47ccbe44ca5349f9ff9ddd8f4cc9771d16dba281663e70c64ff81b7f3ed17ead5960159b8ad0b

data/README.md

@@ -8,25 +8,143 @@ Add this line to your application's Gemfile:
 
     gem 'radriar'
 
-And then execute:
+## Conventions and included components
 
-    $ bundle
+* API based on [Grape](https://github.com/intridea/grape)
+* Model representation with [representable](https://github.com/apotonick/representable)
+* Use of the `represent` and `represent_each` helpers inside the API, or a Grape formatter
+  _(coming soon)_.
+* Hypermedia features are based on [HAL](http://stateless.co/hal_specification.html) and
+require [Roar](https://github.com/apotonick/roar).
 
-Or install it yourself as:
+## Key Features
 
-    $ gem install radriar
+__TODO__: Redact
+
+* Key translation (Snake case to underscore and viceversa).
+* Optional field includes (Pass `fields` parameter in URL).
+* Conventional error responses.
+* Optional inclusion/exclusion of hypermedia (HAL).
 
 ## Usage
 
-TODO: Write usage instructions here
+Include the gem in your Gemfile:
+
+```ruby
+gem 'radriar'
+```
+
+Then radriarize your API ;), aka invoke the `#radriarize` method with the specified
+options from your API definition.
+
+``` ruby
+class UserAPI < Grape::API
+  radriarize representer_namespace: 'MyApp::Representers',
+             hypermedia: true,
+             translate_keys: true
+```
+
+### Dynamic APIs
+
+Assuming you're using the right conventions (to be redacted) this will magically
+turn your API from this:
+
+```javascript
+{
+  "id": "blackxored",
+  "first_name": "Adrian",
+  "last_name": "Perez",
+  "avatar_url": "...",
+  "hireable": false,
+  "registered_at": "...",
+  "social_urls": {
+    "github":  "https://github.com/blackxored",
+      "twitter": "https://twitter.com/blackxored"
+    },
+  "comments": [ /* ... */],
+}
+```
+
+To this:
+
+```javascript
+{
+  "_links": {
+    "self": {
+      "href": "/users/blackxored"
+    },
+    "html": {
+      "href": "/#/u/blackxored"
+    },
+    "timeline": {
+      "href": "/users/blackxored/timeline"
+    },
+  },
+  "_embedded": {
+    "total": 2,
+    "comments": [ /* ... */ ]
+  },
+  "id": "blackxored",
+  "firstName": "Adrian",
+  "lastName": "Perez",
+  "avatarUrl": "...",
+  "hireable": false,
+  "registeredAt": "2013-06-18T06:37:39.248Z",
+  "socialUrls": {
+    "github":  "https://github.com/blackxored",
+    "twitter": "https://twitter.com/blackxored"
+  },
+}
+```
+
+### Partial Responses
 
-## Features
+You can request partial responses (ideal for mobile apps). Just hit any endpoint with an optional `fields` attribute.
+
+(__TODO__: Check that key translation works at the partial response level)
+
+From the response above:
+
+```shell
+curl $URL?fields=id,firstName,avatarUrl
+```
+
+Will return the following JSON document:
+
+```javascript
+{
+  "id": "blackxored"
+  "firstName": "Adrian",
+  "avatarUrl": "..."
+}
+```
+
+### Error Conventions
 
 __TODO__: Redact
-* Key translation (Snake case to underscore and viceversa).
-* Optional field includes (Pass `fields` parameter in URL).
-* Conventional error responses.
-* Optional inclusion/exclusion of hypermedia (HAL).
+
+### Pagination
+
+__TODO__: Test and implement
+
+All your collection get automated pagination by default. In the case of hypermedia APIs it also includes pagination links.
+
+```javascript
+{
+    "_links": {
+        "self":  "/collection?page=3",
+        "first": "/collection",
+        "next":  "/collection?page=4"
+        "prev":  "/collection?page=2",
+        "last":  "/collection?page=10"
+    },
+    "_embedded": {
+      "collection": [ /*...*/]
+    },
+    "total": 250,
+    "per": 25
+}
+```
 
 ## Contributing
 

data/TODO.md

@@ -4,3 +4,4 @@
 * Paginate collections automatically
 * Exposed actions as links
 * Figure out whether to do key translation in links or not.
+* Check if key translation works at the partial response level.

data/lib/radriar/version.rb

@@ -1,3 +1,3 @@
 module Radriar
-  VERSION = "0.1.0.alpha.2"
+  VERSION = "0.1.0.alpha.3"
 end

data/radriar.gemspec

@@ -22,8 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", ">= 3.2"
   spec.add_dependency "representable", ">= 1.8.0"
-  spec.add_dependency "roar"
-  spec.add_dependency "grape"
+  spec.add_dependency "roar",          ">= 0.12.7"
+  spec.add_dependency "grape",         ">= 0.6.1"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: radriar
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.2
+  version: 0.1.0.alpha.3
 platform: ruby
 authors:
 - Adrian Perez
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.7
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement