farmbot-resource 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e30f1034ba61c2be980b07431ad78f18c16ba05
+  data.tar.gz: dd69a2001d79e5cface4c0473c11660f18c09475
+SHA512:
+  metadata.gz: fc0a073cc0d2f47328ae4408d745c43f45717af800953b97cf34ea973797e6e450033877bdfabaf1db6ac918ab24392100e62037b8962fdc58f99196928458f0
+  data.tar.gz: 30500e2196c07aac086e6bc9d285dd53af5bcce65d0a55e513083e859cff8fdd2fbb08b2af6f48414c1cafcac774d70cb78eba35f3dbbce74fad3af8975ce2c9

data/.gitignore

@@ -0,0 +1,48 @@
+*.pstore
+*.gem
+*.rbc
+*.swp
+.bundle/*
+.DS_Store
+.idea/*
+.loadpath
+.project
+.ruby-gemset
+.ruby-version
+/.bundle
+/.bundle/
+/.yardoc/
+/_yardoc/
+/coverage/
+/coverage/
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/doc/
+/InstalledFiles
+/lib/.build
+/lib/bundler/man/
+/log/*.log
+/pkg/
+/rdoc/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp
+/tmp/
+config.yml
+coverage/**
+credentials.yml
+doc/*
+doc/**/*
+Gemfile.lock
+log/*
+notes.rb
+settings.rb
+/lib/.build
+write_db_settings.rb
+snippet.coffee
+snippets.rb
+tmp/**/*
+*.rb~
+serial_port.txt
+*fiddle*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

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

data/README.md

@@ -0,0 +1,29 @@
+# Farmbot Resource
+
+Adapter gem for Farmbot Web App API. Currently used in Raspberry Pi controller to support scheduling operations.
+
+# Available Resources
+
+ * Sequences
+ * Schedules
+
+Need more than what's available? Raise an issue.
+
+# Usage
+
+```ruby
+client = FbResource::Client.new do |config|
+  config.uuid  = 'xyxyxyxy-1234-5678-5345-453453453453'
+  config.token = '229458cgsdfgsdfgsdfaasdfasdfasdfasdfasda'
+  config.url   = 'http://my.farmbot.it'
+end
+
+# Simple use case: get all schedules
+# Returns array of hashes
+schedules = client.schedules.all
+
+# Another use case: cache busting with fetch()
+# Results are always cached until fetch() is called
+sequences = client.sequences.fetch.all
+
+```

data/lib/client.rb

@@ -0,0 +1,20 @@
+require_relative 'config'
+
+module FbResource
+  class Client
+    attr_reader :config
+
+    def initialize(&blk)
+      @config = Config.build
+      yield(@config)
+    end
+
+    def schedules
+      @schedules ||= FbResource::Schedules.new(config)
+    end
+
+    def sequences
+      @sequences ||= FbResource::Sequences.new(config)
+    end
+  end
+end

data/lib/config.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+
+module FbResource
+  class Config < OpenStruct
+    def creds
+      { BOT_UUID: self.uuid, BOT_TOKEN: self.token }
+    end
+
+    def self.build
+      # Set defaults
+      self
+        .new
+        .tap {|obj| obj.url = 'http://localhost:3000'}
+    end
+  end
+end

data/lib/fb_resource.rb

@@ -0,0 +1,6 @@
+require 'rest-client'
+require 'json'
+
+require_relative 'resources/schedules'
+require_relative 'resources/sequences'
+require_relative 'client'

data/lib/http/abstract_resp.rb

@@ -0,0 +1,16 @@
+class AbstractResp
+  attr_reader :body, :request, :response
+
+  def initialize(body, request, response)
+    @body, @request, @response = body, request, response
+  end
+
+  def obj
+    JSON.parse(body.to_s)
+  rescue JSON::ParserError
+    body
+  end
+
+  def ok; self; end
+  def no; self; end
+end

data/lib/http/bad_http_resp.rb

@@ -0,0 +1,5 @@
+class BadHttpResp < AbstractResp
+  def no
+    yield(body, request, response)
+  end
+end

data/lib/http/good_http_resp.rb

@@ -0,0 +1,5 @@
+class GoodHttpResp < AbstractResp
+  def ok
+    yield(obj, request, response)
+  end
+end

data/lib/http/http.rb

@@ -0,0 +1,31 @@
+require_relative 'abstract_resp'
+require_relative 'bad_http_resp'
+require_relative 'good_http_resp'
+
+module FbResource
+  class Http
+    def self.get(url, headers)
+      i = self.new(nil, nil, nil)
+      RestClient.get(url, headers) do |a, b, c|
+        i.body, i.request, i.response = a, b, c
+        i.run
+      end
+    rescue => e
+      BadHttpResp.new(e, e, e) # ?
+    end
+
+    attr_accessor :body, :request, :response
+
+    def initialize(body, request, response)
+      @body, @request, @response = body, request, response
+    end
+
+    def run
+      (success? ? GoodHttpResp : BadHttpResp).new(body, request, response)
+    end
+
+    def success?
+      response.code[0].to_i == 2
+    end
+  end
+end

data/lib/resources/abstract_resource.rb

@@ -0,0 +1,39 @@
+require_relative '../http/http'
+
+module FbResource
+  class FetchError < Exception; end
+  class AbstractResource
+    class << self
+      attr_writer :path
+      def path
+        @path or
+        raise "Set a resource path on your resource class via self.path="
+      end
+    end
+
+    attr_accessor :conf
+
+    def initialize(conf)
+      @conf = conf
+    end
+
+    def fetch
+        Http
+          .get(conf.url + self.class.path, conf.creds)
+          .no { |e| no(e) }
+          .ok { |obj, req, res| fetch_ok(obj, req, res) }
+    end
+
+    def no(error)
+      raise FetchError, "Error fetching #{self.class.to_s}: #{error.message}"
+    end
+
+    def fetch_ok(obj, request, response)
+      @all = obj
+    end
+
+    def all
+      @all || fetch
+    end
+  end
+end

data/lib/resources/schedules.rb

@@ -0,0 +1,7 @@
+require_relative 'abstract_resource'
+
+module FbResource
+  class Schedules < AbstractResource
+    self.path = '/api/schedules/'
+  end
+end

data/lib/resources/sequences.rb

@@ -0,0 +1,7 @@
+require_relative 'abstract_resource'
+
+module FbResource
+  class Sequences < AbstractResource
+    self.path = '/api/sequences/'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'simplecov'
+SimpleCov.start { add_filter "/spec/" }
+
+Dir['spec/fakes/**/*.rb'].each { |file| load file }
+require_relative '../lib/farmbot-pi'
+require_relative '../lib/controllers/exec_sequence_controller'
+require_relative '../lib/command_objects/commands'
+require_relative '../lib/models/status_storage.rb'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end
+
+# This is used for testing things that require an event loop. Once run, you can
+# observe / make assertions on side effects.
+def within_event_loop(ticks = 20)
+  EM.run do
+    bot.status[:BUSY] = 0
+    EM.tick_loop { (ticks < 1) ? EM.stop : ticks -= 1 }
+    yield
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: farmbot-resource
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rick Carlino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: REST API adapter for Farmbot web app.
+email:
+- rick.carlino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- lib/client.rb
+- lib/config.rb
+- lib/fb_resource.rb
+- lib/http/abstract_resp.rb
+- lib/http/bad_http_resp.rb
+- lib/http/good_http_resp.rb
+- lib/http/http.rb
+- lib/resources/abstract_resource.rb
+- lib/resources/schedules.rb
+- lib/resources/sequences.rb
+- spec/spec_helper.rb
+homepage: https://github.com/FarmBot/farmbot-resource
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby Gem to access resources on Farmbot Web App
+test_files:
+- spec/spec_helper.rb
+has_rdoc: