machineshop 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20e82d5fac370db4aa18d4c2d82836afd9bab0b8
-  data.tar.gz: cf7d16a42671405c07cfc05a993091f2fdc72fff
+  metadata.gz: 5d54f636ead5b398e7076611d3aafa0fe4edacbd
+  data.tar.gz: 75a98f285a8c2b9b0d571e269e470048f869bbc5
 SHA512:
-  metadata.gz: e8b764819235588e57f4b130a5c732aab825a2df6640a9cd12ed1fb01450f0bdfc70f946ae20ab4fcd423356e653ad42e701a18e2e10ecdaf7dc312a0a87cb7f
-  data.tar.gz: 9da65ab7bff06efd10637bcb3d16ad815e7288261c0dbb3f2233aa8dda7a80c77d7b569654abd5ba2b75b11a3e9dd3b2019f198014df499843a8bd1f6ceae36d
+  metadata.gz: ffd6bca5ec40d674a5a7143e68b7307948427bba658e7c9a8597e52e182806dd6fb7fe67317c31b24873ca7e795e93c02121894c29ab4fa4ea1d48bf35108e21
+  data.tar.gz: 183d8bc7b1065c036d26cd89a371faddfb62c13246f9ae3015eea5f3db8805dc7ade18425403834d31fb30cddbcdaa239d34e41219bbe910f3a6264c00e51ca9

data/README.md

@@ -20,6 +20,15 @@ Or install it yourself as:
 
 ## Usage
 
+### Setting client specific platform URL
+
+
+> **Caution: Only If you have custom API endpoints**
+
+    MachineShop.api_base_url= 'http://stage.services.machineshop.io/api/v0/myClient'
+    
+
+
 ### Authentication 
 Allow a user to authenticate
 
@@ -28,16 +37,16 @@ Allow a user to authenticate
         :password => "password"
     )   
 
----
+
 * ##### Http_method : Post
 
 * ##### Parameters :
  * email _string_
  * password _string_
 
-* ##### Response Example
+##### Response Example
+
 
-----
     {
     "id" => "8e98188e981800aaef000001",
         "_id" => "8e98188e981800aaef000001",
@@ -62,24 +71,24 @@ Allow a user to authenticate
         "role" => "admin",
         "sign_in_count" => 234,
         "tag_ids" => [],
-        "http_code" => 200
-}
+        "http_code" => 200}
 
 ### Get All user roles 
 Get all the roles assigned to the current user
 
         MachineShop::User.all_roles(auth_token)
 
----
+
 * ##### Http_method : Get
 
 * ##### Parameters :
- * auth_token ___ _string_
+
+ * auth\_token: _string_
   > obtained from #authentication
 
-* ##### Response Example
+##### Response Example
+
 
-----
     [
     "admin",
     "publisher",
@@ -92,18 +101,19 @@ Get User object to apply the following actions
 > user.update,
 > user.delete
 
-
         MachineShop::User.retrieve(user_id, auth_token)
 
----
 * ##### Http_method : Get
 
 * ##### Parameters :
  * auth\_token _string_
  * user\_id:   _string_
-  > available in response object from #authentication
+ 
+ 
+ > auth_token available in response object from #authentication
+
+##### Response Example
 
-* ##### Response Example
 
  > Same as from authenticate
 
@@ -115,7 +125,6 @@ Get User object to apply the following actions
          :per_page => 10},
         auth_token)
 
----
 * ##### Http_method : Get
 
 * ##### Parameters :
@@ -129,9 +138,8 @@ Get User object to apply the following actions
  > Number of items to display
  * auth\_token
 
-* ##### Response Example
+##### Response Example
 
-----
 
     [{
     "id": "9584216470180077f7000157",
@@ -184,23 +192,23 @@ Get User object to apply the following actions
     "user_id": "11161696201800aaef0000459"} ]
 
 
-
+---
 ### Retrieve Device 
 
     specificDevice = MachineShop::Device.retrieve(device_id, auth_token)
 
----
 * ##### Http_method : Get
 
 * ##### Parameters :
  * device\_id
+ 
  > device id
 
  * auth\_token
+ 
 
-* ##### Response Example
+##### Response Example
 
-----
 
     {
     "id" => "51795428911800d51400016c",
@@ -229,6 +237,7 @@ Get User object to apply the following actions
         "user_id" => "11161696201800aaef000056",
         "http_code" => 200}
 
+---
 
 ### Create device instance for the device
 
@@ -238,16 +247,18 @@ Get User object to apply the following actions
         :active => "yes"
     }
 
----
+
+
 * ##### Http_method : Post
 
 * ##### Parameters :
  * name
  * active
 
-* ##### Response Example
+##### Response Example
+
+
 
-----
 
     {
     "id" => "30048840211800a9c600000c",
@@ -287,7 +298,7 @@ Create a new device
             :image_url =>  "http://someurl.com/your_image.png",
             :manual_url =>  "http://someurl.com/manual.pdf"},auth_token)
 
----
+
 
 * Http_method : Post 
 
@@ -301,13 +312,14 @@ Create a new device
         }
     )
 
+---
 
 ### Get the device instances
 Get all the device instances of the user
 
     MachineShop::DeviceInstance.all({:name => "instance_name"}, auth_token)
 
----
+
 > Pass first parameter as empty array if no filters to be applied 
 
 * ##### Http_method : Get
@@ -318,9 +330,8 @@ Get all the device instances of the user
 
  * * name
 
-* ##### Response Example
+##### Response Example
 
-----
 
     {
     "id" => "51795428911800d51400016c",
@@ -362,6 +373,7 @@ or without filters
 > where specficiDevice is the object from retrieve
 
 
+---
 
 ### Create Customers
 
@@ -375,7 +387,7 @@ or without filters
 
                                             },auth_token)
 
----
+
 * ##### Http_method : Post
 
 * ##### Parameters 
@@ -383,9 +395,9 @@ or without filters
  * Post parameters:  _array of params_ 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
 
-----
 
     {
     "id" => "958421647080007a004506b",
@@ -417,7 +429,7 @@ Retrieve customer by Id
 
     retrievedCustomer = MachineShop::Customer.retrieve(customer_id, auth_token)
 
----
+
 * ##### Http_method : Get
 
 * ##### Parameters 
@@ -425,9 +437,10 @@ Retrieve customer by Id
  * customer\_id _string_
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
+
 
-----
     same as above
 
 ----
@@ -438,7 +451,7 @@ Retrieve customer by Id
     MachineShop::Customer.update(customer_id,auth_token,{:notification_method => 'email'})
 
 
----
+
 * ##### Http_method : Put
 
 * ##### Parameters 
@@ -447,9 +460,9 @@ Retrieve customer by Id
  * update parameters:  _array of params_ 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
 
-----
 
     {
     "id": "958421647080007a004506b",
@@ -477,32 +490,34 @@ Retrieve customer by Id
     retrieved_cust.update({:notification_method => 'email'})
 
 
+---
 ### Delete Customer
 Delete the Customer
 
     retrievedCustomer.delete
 
----
+
 > retrievedCustomer is the retrieved customer object
 
 * ##### Http_method : delete
 
 
-* ##### Response Example
+##### Response Example
+
 
-----
 
     {"http_code":200,"deleted":true}
 
 
+---
 
 ### List rules
 List all the rules of user
 
     MachineShop::Rule.all({},auth_token)
 
----
-> Filter parameters else empty array 
+
+> First parameters is filters or empty array should be provided
 
 * ##### Http_method : Get
 
@@ -511,9 +526,9 @@ List all the rules of user
  * filter parameters:  _array of params_ 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
 
-----
 
     {
     "id": "958421647080007a004506b",
@@ -587,9 +602,9 @@ Create a rule
  * create parameter:  _json array of params_ 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
 
-----
 
     {
     "id" => "5395b245385f7fe266000037",
@@ -626,7 +641,7 @@ Create a rule
 
 
 ### Retrieve Rule
-    specificRule = MachineShop::Rule.retrieve("rule_id",auth_token)
+    specificRule = MachineShop::Rule.retrieve(rule_id,auth_token)
     
 * ##### Http_method : Get
 
@@ -636,9 +651,9 @@ Create a rule
 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
 
-----
 
      {
     "id" => "5395b245385f7fe266000037",
@@ -679,13 +694,13 @@ Delete the rule
 
 * ##### Http_method : Delete
 
-* ##### Response Example
+##### Response Example
+
 
-----
     
     {"http_code":200,"deleted":true}
 
-----
+---
 
 ###  Get join rule conditions
 Get join rule conditions
@@ -699,9 +714,10 @@ Get join rule conditions
 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
+
 
-----
     [
     ["A few conditions where only one needs to be true.", "or_rule_condition"],
     ["A few conditions that must all be true.", "and_rule_condition"]]
@@ -719,9 +735,9 @@ Get join rule conditions
 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
 
-----
     [
     [
         ["A numeric payload value is greater than a specified threshold."]
@@ -746,9 +762,9 @@ Get join rule conditions
 
  * auth_token
 
-* ##### Response Example
+##### Response Example
+
 
-----
     {: _id => "958421647080007a004506b",
     : active => true,
     : created_at => "2014-02-05T21:22:53Z",
@@ -772,6 +788,186 @@ Get join rule conditions
 
 ----
 
+
+###  Get Reports
+Get all the report of the device
+
+    MachineShop::Report.all({:device_instance_id => '958421647080007a004506b',:per_page=>'10',}, auth_token)
+    
+> First parameter should be empty array if no filter is to be applied.
+
+* ##### Http_method : Get
+
+* ##### Parameters 
+ * device\_instance\_id: _string_
+ 
+ * per\_page: _string_
+
+
+ * auth_token
+
+##### Response Example
+
+
+    {
+    "id": "958421647080007a004506b",
+    "_id": "958421647080007a004506b",
+    "created_at": "2014-06-10T08:19:34Z",
+    "deleted_at": null,
+    "device_datetime": "2014-06-10T08:19:37+00:00",
+    "device_instance_id": "3004884021800aaef0056893",
+    "duplicate": false,
+    "payload": {
+        "event": {
+            "eventIdx": 0,
+            "policy_id": "f7f8a8e538530000092d1c6b",
+            "values": {
+                "lightLevel": 320456,
+                "fixType": 3,
+                "motion": {
+                    "distance": 0,
+                    "floor_change": 0,
+                    "context": 5,
+                    "steps": 0
+                },
+                "batteryExternalPower": false,
+                "utcTime": 1402388377,
+                "temperature": 429,
+                "health": {
+                    "temp4": 15515,
+                    "heartRateMon": {
+                        "devBodyLoc": 141,
+                        "rr": 15504,
+                        "heartRate": 142,
+                        "devName": "One_HRM",
+                        "energy": 15503
+                    },
+                    "sensorPod": {
+                        "devBodyLoc": 151,
+                        "distance": 15507,
+                        "floor_change": -107,
+                        "context": 146,
+                        "stride_len": 150,
+                        "devName": "myPod",
+                        "steps": 15508
+                    },
+                    "temp2": 15513,
+                    "temp3": 15514,
+                    "temp1": 15512
+                },
+                "location": {
+                    "altitude": 0,
+                    "hor_error_min": 0,
+                    "latitude": 64.37989,
+                    "vert_error": 0,
+                    "hor_error_max": 0,
+                    "longitude": -122.08374
+                },
+                "pressure": 42,
+                "speed": {
+                    "heading": 9000,
+                    "ver_speed": 0,
+                    "hor_speed": 10000
+                },
+                "batteryLevel": 87
+            },
+            "reportMask": 14463
+        },
+        "sequenceId": 44725
+    },
+    "profile_timestamps": {
+        "translator": "2014-06-10T08:19:37Z",
+        "worker": "2014-06-10T08:19:34Z",
+        "device": "2014-06-10T08:19:37Z",
+        "platform": "2014-06-10T08:19:50Z"
+    },
+    "raw_data": "AQEAAgAAFnRyYWNrZXIAc2ltdWxhdG9yAENTUgCutQEAOH8BJl+Xgrc7f+YAAAAAAAAAACcQAAAjKAUAAAAAAAAAAABTlr+ZAAMBrQAqAFc/DU9uZV9TZW5zcm9Qb2SRkgAAPJQAADyTlZaXB09uZV9IUk2NjjyPPJA8mDyZPJo8mwAE48gAAA==",
+    "report_processor": "java",
+    "stale": null,
+    "updated_at": "2014-06-10T08:19:34Z"}
+    
+---
+
+
+###  Retrieve Report by report_id
+Get all the report of the device
+
+    MachineShop::Report.retrieve(report_id,auth_token)
+    
+> First parameter should be an empty array if no filter is to be applied.
+
+* ##### Http_method : Get
+
+* ##### Parameters 
+ * report\_id: _string_
+ * auth_token
+
+##### Response Example
+    Same as above
+---
+
+
+###  Get Meters
+Get all the meters
+
+    MachineShop::Meter.all({}, auth_token)
+    
+
+* ##### Http_method : Get
+
+* ##### Parameters 
+
+ * auth_token
+
+##### Response Example
+
+
+    {
+    "id": "958421647080007a004506b",
+    "_id": "958421647080007a004506b",
+    "body": null,
+    "client_ip": "110.34.0.243",
+    "created_at": "2014-06-03T17:45:08Z",
+    "device_instance_id": null,
+    "request_at": "2014-06-03T17:45:10+00:00",
+    "request_method": "get",
+    "request_path": "/api/v0/platform/device",
+    "request_route": "get '/device'",
+    "response_code": 200,
+    "updated_at": "2014-06-03T17:45:08Z",
+    "user_id": "3004884021800aaef0056893"}
+   
+   
+> meters via user 
+
+    user.meters
+    
+> where user is the object obtaied from #authentication 
+
+    user = MachineShop::User.authenticate(
+      :email => publisher_username,
+      :password => publisher_password    
+---
+
+
+###  Retrieve meter
+Get meter by meter_id
+
+    MachineShop::Meter.retrieve(meter_id, auth_token)
+    
+* ##### Http_method : Get
+
+* ##### Parameters 
+ * meter\_id: _string_
+ * auth_token
+
+##### Response Example
+
+    same as above
+
+---
+
+
 ## Contributing
 
 1. Fork it