farmbot-resource 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da6767552fe92e942c25a01f2756e1e30bf3b4c5
-  data.tar.gz: 2d8a8ca3e9fdcbc4d9b2f22ae3bbf5d820bd00ad
+  metadata.gz: bf29be0a07977f8f371dc75c2a0c9932fe0e56ef
+  data.tar.gz: 93464e6dc9b378052370e1ff724affd13f606515
 SHA512:
-  metadata.gz: 8bfecb0cb718248fd27ad46bbf5fe3c08267e9d6a50fb530a83abc1552ec9343712d5d1c31e73b19e78052d7f9dbf3fba6d4c08b675712d6f4f686a6929cb180
-  data.tar.gz: 9c65d51f98eef86e557cb2c2c7d6f11dfb3c1b6f41db5689260575240b9dba0120a850724b22811c15dc1260991f2939d0b7703c2fe2300989fb8b4de7fbf510
+  metadata.gz: f7f408b098fa8bfb646dd7b79b4580638790354302dc81848da8803475a63052904ce74c9ac7f1dc46af468cac5be75b625e3e56f049d58284747ae7d59da966
+  data.tar.gz: 84651b320c0aa518c91662e998fc78188bb4d783407ad3954b84e01a9751671e223041c3660b257ba0a429a7a66251695c1bf8d5a11001dd41af5c2c6bd6ce77

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'rspec'
-gem 'simplecov'
+# gem 'rspec'
+# gem 'simplecov'
 gem 'rest-client'

data/README.md

@@ -8,17 +8,33 @@ Adapter gem for Farmbot Web App API. Currently used in Raspberry Pi controller t
  * Schedules
  * Plants
 
-Need more than what's available? Raise an issue.
+Need more than what's available? Raise an issue and we can add your resource to the list (PRs are also welcome).
 
 # Usage
 
+First, you will need an API token.
+
+```ruby
+token = FbResource::Client.get_token(email: 't@g.com',
+                                     password: 'shhh...',
+                                     # OPTIONAL: Defaults to "my.farmbot.io"
+                                     # if not specified.
+                                     url: "http://localhost:3000")
+# Returns really long JSON Web Token...
+# => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9....'
+```
+
+Once you have an API token, you can create a 'client'.
+
 ```ruby
 client = FbResource::Client.new do |config|
-  config.uuid  = 'xyxyxyxy-1234-5678-5345-453453453453'
-  config.token = '229458cgsdfgsdfgsdfaasdfasdfasdfasdfasda'
-  config.url   = 'http://my.farmbot.it'
+  config.token = token
 end
+```
+
+Client objects can access API resources such as schedules and sequences.
 
+```ruby
 # Simple use case: get all schedules
 # Returns array of hashes
 schedules = client.schedules.all
@@ -28,3 +44,5 @@ schedules = client.schedules.all
 sequences = client.sequences.fetch.all
 
 ```
+
+**See example.rb for a runnable sample**.

data/example.rb

@@ -0,0 +1,21 @@
+require_relative './lib/farmbot-resource'
+require 'pry'
+token = FbResource::Client.get_token(email: 'admin@admin.com',
+                                     password: 'password123',
+                                     # Defaults to "my.farmbot.io" if not specified.
+                                     url: "http://localhost:3000")
+
+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 schedules")
+client.schedules.all # => []
+
+puts ("Grabbing plants")
+client.plants.all # => []
+
+puts ("Grabbing sequences")
+client.sequences.all # => []

data/lib/client.rb

@@ -1,12 +1,26 @@
 require_relative 'config'
+require 'base64'
 
 module FbResource
+  class InvalidConfig < StandardError; end
   class Client
     attr_reader :config
 
     def initialize(&blk)
       @config = Config.build
       yield(@config)
+      post_config
+    end
+
+    def self.get_token(url: "http://my.farmbot.io", email:, password:)
+      # 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
     end
 
     def schedules
@@ -20,5 +34,20 @@ module FbResource
     def plants
       @plants ||= FbResource::Plants.new(config)
     end
+
+    def api_url
+      JSON.parse(Base64.decode64(config.token.split(".")[1]))["iss"]
+    end
+
+  private
+
+    def invalidate(msg)
+      raise InvalidConfig.new, msg
+    end
+
+    def post_config
+      invalidate("config needs `token` attribute") unless @config.token
+      @config.url = api_url
+    end
   end
 end

data/lib/config.rb

@@ -2,8 +2,8 @@ require 'ostruct'
 
 module FbResource
   class Config < OpenStruct
-    def creds
-      { BOT_UUID: self.uuid, BOT_TOKEN: self.token }
+    def http_headers
+      { Authorization: self.token }
     end
 
     def self.build

data/lib/resources/abstract_resource.rb

@@ -19,7 +19,7 @@ module FbResource
 
     def fetch
         Http
-          .get(conf.url + self.class.path, conf.creds)
+          .get(conf.url + self.class.path, conf.http_headers)
           .no { |obj, req, res| fetch_no(obj, req, res) }
           .ok { |obj, req, res| fetch_ok(obj, req, res) }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: farmbot-resource
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rick Carlino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2016-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,6 +107,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- example.rb
 - lib/client.rb
 - lib/config.rb
 - lib/farmbot-resource.rb