hyper-resource 1.0.0.lap79 → 1.0.0.lap80

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9430772935e6c7baa1396aa73c09266072a6312a22fe66a51e50c7b01053e579
-  data.tar.gz: 50f91a54c04446790d2dbc8a8f3d54abb0a554e4ab9860099ceab11e2b3e1807
+  metadata.gz: 89583b7e921ac559d94a7edba949cc461de7ae50cf0ad84f88814fa340001e96
+  data.tar.gz: ae6d2726d65ea5ac78f606aa48a2f913d6a19383e3f2470a4e6898f4f664282d
 SHA512:
-  metadata.gz: 98c4f86d6fc72c03fa0892effa4b0c66a1751d6a32b856e1c218b16baf3034e3963b5c524b7665fe3adb9ea913930c32c562f0b64c8127bb48116efc5008dad6
-  data.tar.gz: 5c69b6391ca3dcc1b22ad53c625f3c8f7c6041c025a7b5ac445cc1f6c946c9b8481e14221be7a68443fc648ca407a016fa8ae8555a0c4cefe6840c344f85c88a
+  metadata.gz: c41fea889711dcbaae760a80c43b985188fddd0c1aeb363bc15c4b7c8ca48f32585f358fb43ed232bed52df01f6248dd2ba82459a50651ffa44ae1bcf798ab3b
+  data.tar.gz: e71449e31b590f2ea670433d77e339305c1201a52c205ac83813dcfc03796b6f223db45b07cb82bfc0cd9227b52f2991abd2cc9e53d0cdbc1ac23d5afd58d9d5

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.yardoc
+Gemfile.lock

data/.yardopts

@@ -0,0 +1 @@
+--no-private -o docs - API.md JSON_format.md PubSub.md

data/API.md

@@ -0,0 +1,62 @@
+Hyper-Resource provides two API levels
+
+The high level API and the promise API
+
+## High level API
+
+The high level api allows for a simple use of records and is in general recommended for read accesses. For write accesses, saving of data, the promise API is recommended, unless weather the data was saved or not is not of importance.
+
+#### Schema of accessing data in the high level API:
+
+```
+my_record = MyModel.find('1')
+my_record.a_property
+```
+
+1. component is rendered
+2. during render a fetch is triggered
+2.1 component is registered as observer
+2.2 component gets dummy data to render
+3. render completes, data is fetched in the background
+4. when the data arrived
+4.1 the component as observer is notified
+4.2 a state change happens and the component is rendered again with the real data
+
+#### Schema of saving data in the high level API
+
+```
+my_record.a_property = 2
+my_record.save
+```
+
+Saving of data in the high level API is optimistic:
+
+1. triggering a save of data
+2. the method called returns immediately
+3. a successful save is assumed
+
+## Promise API
+
+All methods of the promise API are prefixed by 'promise_', so instead of my_redord.save in the high level API, in the promise API one would use my_record.promise_save.
+All methods in the promise API return a promise.
+In general the pattern is:
+
+```
+my_record.a_property = 2
+
+my_record.promise_save.then do |record|
+  # save was successful
+  # do something here
+end.fail do |response|
+  # save failed
+  # response is the http response object
+end
+```
+
+for example, finding a record:
+
+```
+MyModel.promise_find('1').then do |record]
+  my_record.a_property
+end
+```

data/Gemfile

@@ -0,0 +1,2 @@
+gem 'opal-jquery', git: 'https://github.com/opal/opal-jquery.git', branch: 'master'
+gemspec

data/JSON_format.md

@@ -0,0 +1,62 @@
+## JSON format
+
+### In case of a error:
+```json
+{
+  "error": "error message"
+}
+```
+along with HTTP response status set accordingly
+
+### A single record
+```json
+{
+  "record.class.to_s.underscore": {
+    "id": "a_string",
+    "updated_at": "time stamp, required at several places",
+    "further_properties": "at will"
+  }
+}
+```
+
+### A relation
+```json
+{
+  "record.class.to_s.underscore": {
+    "id": "a_string",
+    "relation_name": [
+      {
+        "member_record.class.to_s.underscore": {
+          "id": "a_string",
+          "further_properties": "at_will"
+        }
+      },
+      // further records ...
+    ]
+  }
+}
+```
+
+### A scope
+```json
+{
+  "record.class.to_s.underscore": {
+    "scope_name": [
+      {
+        "member_record.class.to_s.underscore": {
+          "id": "a_string",
+          "further_properties": "at_will"
+        }
+      },
+      // further records ...
+    ]
+  }
+}
+```
+
+### A rest_method or a rest_class_method
+```json
+{
+  "result": result_value_or_object
+}
+```

data/PubSub.md

@@ -0,0 +1,20 @@
+## PubSub with HyperResource
+
+PubSub is handled in the controller. In your controller:
+```
+include Hyperloop::Resource::PubSub
+```
+
+Then you can use the PubSub methods of Hyperloop::Resource::PubSub.
+
+For example, a record has been requested, subscribe to it in the show action of the controller:
+```
+  subscribe_record(my_record)
+```
+
+When somebody updates the record, in the update action for example:
+```
+  publish_record(record)
+```
+
+All subscribers will receive a message indicating, that the record has been updated.

data/README.md

@@ -1,5 +1,7 @@
 # hyper-resource
 
+[Github Repo](https://github.com/janbiedermann/hyper-resource "Github Repo")
+
 HyperResource is an affective way of moving data between your server and clients when using Hyperloop and Rails.
 
 [![Reactivity Demo](http://img.youtube.com/vi/fPSpESBbeMQ/0.jpg)](http://www.youtube.com/watch?v=fPSpESBbeMQ "Reactivity Demo")