farmbot-resource 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0965243df1655e7a1156774fbc842f4188aea81c
-  data.tar.gz: 3548156c249e6696bfd977ce8ac0134ba6fadc13
+  metadata.gz: 4811aa1f4ed868f628643ed48f776a9ff9211ebe
+  data.tar.gz: b05169269961b8f17ccd290ba5c7adff7b6d2f44
 SHA512:
-  metadata.gz: a60fe235033b33a52e71a1f9f651191345adc04a65b03ca961e5ffaeade3e5a7e27da086592f175f0fdd9ab8d185dd85c9ecbc83cfbf1a1ec4f9b3fa1b400e33
-  data.tar.gz: 693fbbff6a7b75a1690c827d431f649b93c4fe6ef3bbda9848636864b0ec3d03551326370f87ad75d5a4fe17a2b6b2bcc6701c52ca90278865f23bff7b74da23
+  metadata.gz: 18b5028d03d05edd060254b7ed4355a9ac0daeab2c65107fef790df4862867e00ddde9e84831a772d4a07e981bd84f386f4ff93632a1891773a76686ebab9dd2
+  data.tar.gz: 63e0a8e50269ee87a8f52034ce3871e5014e2a9a3671c4d6147afa3c4e0bc2cfa6f50924a72db7a8fbb7f621039f7a08d0e50f1dd85375fc880e7a76b0146d2c

data/README.md

@@ -42,7 +42,10 @@ schedules = client.schedules.all
 # Another use case: cache busting with fetch()
 # Results are always cached until fetch() is called
 sequences = client.sequences.fetch.all
-
 ```
 
+# Encryption
+
+The Farmbot web app issues an RSA public key. If you need to sign stuff, the key is accessible via `client.public_key` 
+
 **See example.rb for a runnable sample**.

data/example.rb

@@ -21,3 +21,18 @@ puts("Grabbing devices")
 puts client.device.current.to_s
 puts "Grabbing public key"
 puts client.public_key.to_pem
+puts "Done using email/password. Attempting with credentials file now."
+# Just a fake credentials file, as generated by Farmbot.
+example = File.read("example_credentials.txt")
+# An alternative means of generating a token without a password.
+alt_token = FbResource::Client.get_token(credentials: example,
+                                         url: "http://localhost:3000")
+alt_client = FbResource::Client.new do |config|
+ # Note for users that self host a Farmbot API:
+ # FbResource will grab the URL from the token's "ISS" claim.
+ config.token = token
+end
+puts("Grabbing devices with credentials")
+puts client.device.current.to_s
+puts "Grabbing public key with credentials"
+puts client.public_key.to_pem

data/example_credentials.txt

@@ -0,0 +1,6 @@
+v5UA4zaAfXcZqXfIFVoWxewGELVhx5cTsQkK5hnj/JY9pGAy4PrmKHL07dqb
+J8h+QNmeKvb0QxX0yZDCZEB2d6rP0ya15CU6qEzY8PRHMoZtvxD1OWN9Lwc4
+O+Mo9sMKGVTSUrUWRhNA1qPA41vQ9iWXcUua48rfMvhN4dvcOwz6IkC9DaSu
+5CmbrtUfaVV+92qN318Qr+WAq/wCb/lX/bxHKU95n9WV4pgUKQKlUN5Cgf86
+ptdq5YrDYhMwFz6F9FBRJ/tQ0gOynMyb2obSa/zJFim8NgxHMpbTPLZd7ZY5
+uQp/DPjRjNEP4/tKNEQtwiPcG2U1i+28hG7MmEWsqw==

data/lib/client.rb

@@ -12,15 +12,18 @@ module FbResource
       post_config
     end
 
-    def self.get_token(url: "http://my.farmbot.io", email:, password:)
+    def self.get_token(url: "http://my.farmbot.io",
+                       email: "EMAIL NOT SET",
+                       password: "PASSWORD NOT SET",
+                       credentials: nil)
       # TODO handle auth errors in a more civilized manner.
       resource_url = url + "/api/tokens"
-      payload = {user: {email: email, password: password}}
-      result = RestClient.post(resource_url, payload)
-      json = JSON.parse(result)
-      token = json["token"]
-      string = token["encoded"]
-      string
+      if(credentials)
+        result = from_credentials(resource_url, credentials)
+      else
+        result = from_email_and_password(resource_url, email, password)
+      end
+      parse_token(result)
     end
 
     # Useful when you need to sign arbitrary secrets and give them to the server
@@ -51,7 +54,14 @@ module FbResource
     end
 
     def api_url
-      JSON.parse(Base64.decode64(config.token.split(".")[1]))["iss"]
+      raw = config.token.split(".")[1]
+      token_string = Base64.decode64(raw)
+      hash = JSON.parse(token_string)
+      hash["iss"]
+    rescue JSON::ParserError
+      msg = "Farmbot Resource couldn't parse the auth token provided:\n\n"
+      msg += token_string + "\n\n"
+      raise InvalidConfig, msg
     end
 
   private
@@ -64,5 +74,22 @@ module FbResource
       invalidate("config needs `token` attribute") unless @config.token
       @config.url = api_url
     end
+
+    def self.from_credentials(resource_url, credentials)
+      payload = {user: {credentials: credentials}}
+      RestClient.post(resource_url, payload)
+    end
+
+    def self.from_email_and_password(resource_url, email, password)
+      payload = {user: {email: email, password: password}}
+      RestClient.post(resource_url, payload)
+    end
+
+    def self.parse_token(result)
+      json = JSON.parse(result)
+      token = json["token"]
+      string = token["encoded"]
+      string
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: farmbot-resource
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rick Carlino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,7 @@ files:
 - README.md
 - Rakefile
 - example.rb
+- example_credentials.txt
 - lib/client.rb
 - lib/config.rb
 - lib/farmbot-resource.rb