toast 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a702e1c3fefb8b0f86ae4169cf2bf0d5c06c59e
-  data.tar.gz: 7909991e0e45f40ab0f9889656a5fa0f64244bb2
+  metadata.gz: 5e4eb8103991d5f602d32c0d0a0f28302c7d8f92
+  data.tar.gz: 555253820fdeed47d6f65c82f7e0f7f4510abfd3
 SHA512:
-  metadata.gz: ae832ad5e6df4d2b1fe56e52125fc2721029bd084c8c8ef7f1c1271d64bffbdea500f3fe9b3fbc3cdac7c47f9762cc3010cee3b8335c406aed1f084a8a2b20e7
-  data.tar.gz: b7c9bd99a118e16f6d722e5bc4323335e85f151be89e59457684426cee8b4c3bf8bd3afaea460620f3013da83d4d27f9e18fc9281505f3d55bef98e0bdd090d6
+  metadata.gz: 423b2edc025b2bd8e31c043303fc6e702dd18bcba559703814e51dd00f7eb29a16c2acb8b7641d4f9ee8b82418e9d2f83dd31fd219bb97743c566ff69a77776f
+  data.tar.gz: 5ee502e2b5b2caf57642a9aec5cb39466b8423cf6053c17ddbec774dc223137aa1b32e28a6a5b05c8c85fcc0f23f79ef49564aa40769c06cb7525f1952b5b54d

data/README.md

@@ -22,7 +22,7 @@ Other features are:
 
 Toast v1 is build for Rails 5. The predecesssor v0.9 supports 3 and 4, but has a much different and smaller DSL.
 
-See the User Manual (to be published soon) for a detailed description.
+See the [User Manual](https://robokopp.github.io/toast) for a detailed description.
 
 Status
 ======
@@ -30,6 +30,8 @@ Status
 Toast v1 for Rails 5 is a complete rewrite of v0.9, which was first published and used in production since 2012. 
 It comes now with secure defaults: Nothing is exposed unless declared, all endpoints have a default authorization hook responding with 401. 
 
+v1 is not compatible with v0.9, and it is not tested with Rails < v5. All configurations must be ported to the new DSL. 
+
 From my point of view it is production ready. I am in the process of porting a large API from v0.9 to v1 that uses all features and it looks very good so far. Of course minor issues will appear, please help to report and fix them. 
 
 Installation
@@ -69,7 +71,7 @@ and let a corresponding model class have this code:
        belongs_to :apple
        has_many :coconuts
 
-       scope :less_than_100, where("number < 100")       
+       scope :less_than_100, -> { where("number < 100") }
      end
 
 Then we can define the API like this (in `config/toast-api/banana.rb`):
@@ -158,7 +160,7 @@ Then we can define the API like this (in `config/toast-api/banana.rb`):
          }
       }
 
-Note, that all `allow`-blocks returning _true_. In practice authorization logic should be applied. An `allow`-block must be defined for each endpoint because it defaults to return `false`, which causes a 401 response.
+Note, that all allow-blocks in the above example return _true_. In practice authorization logic should be applied. An allow-block must be defined for each endpoint because it defaults to return _false_, which causes a _401 Unauthorized_ response.
 
 The above definition exposes the model Banana as such:
 
@@ -190,7 +192,7 @@ The default length of collections is limited to 42, this can be adjusted globall
     GET http://www.example.com/bananas/less_than_100
     --> 200, '[{BANANA}, {BANANA}, ...]'
 
-Any scope can be published this way as well as any model class method returning a relation. 
+Any _scope_ or class method returning a relation can be published this way.
 
 ### Get an associated collection + filter
     GET http://www.example.com/bananas/23/coconuts?max_weight=3
@@ -233,7 +235,7 @@ Toast ingores unknown attributes, but prints warnings in it's log file. Only att
       Link:  "http://www.example.com/coconuts/31"
     --> 200
 
-Toast uses the (unusual) methods LINK and UNLINK in order to express the action of linking or unlinking existing resources. The above request will add _Coconut#31_ to the association _Banana#coconuts_. 
+Toast uses the (unusual) HTTP verbs LINK and UNLINK in order to express the action of linking or unlinking existing resources. The above request will add _Coconut#31_ to the association _Banana#coconuts_. 
 
 
 

data/lib/toast/rack_app.rb

@@ -57,7 +57,7 @@ class Toast::RackApp
     begin
       base_config = get_config(model_class)
     rescue Toast::Errors::ConfigNotFound => error
-      return response :internal_server_error,
+      return response :not_found,
                       msg: "no API configuration found for model `#{model_class.name}'"
     end
 

data/lib/toast/version.rb

@@ -1,3 +1,3 @@
 module Toast
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toast
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - robokopp (Robert Annies)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -90,7 +90,8 @@ files:
 - lib/toast/singular_assoc_request.rb
 - lib/toast/version.rb
 homepage: https://github.com/robokopp/toast
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -100,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='