flowthings 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aaeab445dade8459cd6b0ed1053b9e7bf7e0cd6e
+  data.tar.gz: dd7c921672c1308d472694cd70a8f297390b94a8
+SHA512:
+  metadata.gz: d0405b2e6c30d7311a40da5ca5311f8b0028ed808075141a21c4a22082cca9eca80bed49a310d3f5de09c7ad1e2ef4f25b9c6c1d563f8f64a576692228a189f3
+  data.tar.gz: c8af059a5468092148916ee217252d7ac3102847f3e3f183c2e99935112b5c980d2f3711485eec8a9d59b4b07e6a867ba7e66574c349c6279cc5048468f79bba

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec', '~> 3.2.0'
+  gem 'dotenv'
+end
+
+# Specify your gem's dependencies in flowthings.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,77 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,161 @@
+# Flowthings Gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flowthings'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install flowthings
+```
+
+## Usage
+
+###  `Flowthings::Client.new(options)`
+
+returns a new instance of the client. The client needs your account name and account token in order to connect to the server. You can pass these in the options hash:
+
+```ruby
+{account_name: @account_name, account_token: @account_token}
+```
+
+Or, they are accessible through public functions on the client. You can access the other options in the same way.
+
+The client is composed of services for querying the different domains of the platfrom.
+
+-   `flow`
+-   `drop`
+-   `track`
+-   `group`
+-   `identity`
+-   `token`
+-   `share`
+-   `api_importer`
+-   `mqtt_connection`
+
+### Service Methods
+
+#### `service.create(data, params?)`
+
+```ruby
+client.flow.create path: '/foo/bar'
+```
+
+#### `service.read(id, params?)`
+
+```ruby
+client.flow.read '<flow_id>'
+```
+
+#### `service.update(id, data, params?)`
+
+```ruby
+client.flow.update '<flow_id>', path: '/foo/baz'
+```
+
+#### `service.member_update(id, data, params?)`
+
+```ruby
+client.flow.member_update '<flow_id>', path: '/foo/baz'
+```
+
+#### `service.destroy(id, params?)`
+
+```ruby
+client.flow.destroy '<flow_id>'
+```
+
+#### `service.find(params?)`
+
+```ruby
+client.flow.find filter: "path =~ /\\/greg\\/test\\/ruby/"
+```
+
+#### `service.find_many(filters, params?)`
+
+```ruby
+client.drop.find_many '<flow_id>': '<filter>', '<flow_id2>': '<filter>'
+```
+
+#### `service.simulate(data, params?)`
+
+```ruby
+track = {
+  "drop": {
+    "elems": {
+      "a": 1
+    }
+  },
+  "js": "function (input_drop) {
+        var a = input_drop.elems.a.value;
+        input_drop.elems.b = a  * 3;
+        return input_drop;
+      }"
+}
+
+client.track.simulate track
+```
+#### `service.aggregate(data, params?)`
+
+```ruby
+client.drop("<flow_id>").aggregate "output": ["$count"]
+```
+
+**Note:** Not all services support all the methods. `share`s and `token`s are
+immutable, and so do not support `update`.
+`identity` only supports `read` and `find`.
+Only `track` supports `simulate`, and only `drop` supports `find_many`
+
+The methods return a hash of the platform's response. For instance, `flow.read('flow_id')` will return:
+
+```ruby
+{
+  "id": "<flow_id>",
+  "capacity": "<capacity>",
+  "creationDate": "<creation_date>",
+  "creatorId": "<creator_id>",
+  "lastEditDate": "<last_edit_date>",
+  "path": "<flow_path>"
+}
+```
+
+### Example
+
+For a bunch of examples, look in the platform objects specs.
+
+```ruby
+api = Flowthings::Client.new account_name: <account_name>, account_token: <account_token>
+
+api.flow.read "f55171ff90cf2ece6103ef410"
+
+# => {"id": "f55171ff90cf2ece6103ef410",
+#            "capacity": 1000,
+#            "creationDate": 1427578873318,
+#            "creatorId": "i54af263c0cf25b8ea459c204",
+#            "path": "/greg/test/ruby-drop"}
+
+```
+
+
+## Compatability
+
+Flowthings has been tested in:
+
+MRI 1.9.3, 2.0.0, 2.1.5, 2.2.0, 2.2.1, 2.2.2
+
+We will not support MRI prior to 1.9.3.
+
+Rubinius 2.4.1, 2.5.2
+
+Jruby 1.7.9, 1.7.19, 9000 (on Java 8)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flowthings"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flowthings.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flowthings/version'
+
+Gem::Specification.new do |s|
+  s.name          = "flowthings"
+  s.version       = Flowthings::VERSION
+  s.authors       = ["Greg Meyer"]
+  s.email         = ["dev@flowthings.io"]
+
+  s.summary       = %q{A rubygem for the flowthings.io platform.}
+  s.description   = %q{flowthings.io is an agile intelligence platform that is specifically geared towards the Internet of Things. This is our Ruby Client.}
+  s.homepage      = "https://flowthings.io"
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|s|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.license       = "Apache 2.0"
+
+  s.add_dependency "activesupport", "~> 4.2"
+  s.add_dependency 'excon', '~> 0.44'
+
+  s.add_development_dependency "bundler", "~> 1.8"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "pry", "~> 0.10"
+  s.add_development_dependency "guard", "~> 2.12"
+  s.add_development_dependency "guard-rspec", "~> 4.5"
+end

data/lib/flowthings/client.rb

@@ -0,0 +1,63 @@
+require 'active_support/inflector'
+require 'flowthings/platform_objects/api_task'
+require 'flowthings/platform_objects/drop'
+require 'flowthings/platform_objects/flow'
+require 'flowthings/platform_objects/group'
+require 'flowthings/platform_objects/identity'
+require 'flowthings/platform_objects/mqtt'
+require 'flowthings/platform_objects/share'
+require 'flowthings/platform_objects/token'
+require 'flowthings/platform_objects/track'
+
+module Flowthings
+  class Client
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+    include Flowthings::Connection
+
+    def initialize(options={})
+      @services = [ApiTask, Drop, Flow, Group, Identity, Mqtt, Share, Token, Track]
+      merged_options = Flowthings.options.merge(options)
+
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+
+      service_factory
+    end
+
+    private
+    def get_options
+      opts = {}
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        opts[key.to_sym] = send("#{key}")
+      end
+
+      opts
+    end
+
+    def service_factory
+      @services.each do |service|
+        # service.name.underscore looks like this: flowthings/api_importer
+        # so, I have to split it like that.
+        service_name = service.name.underscore.split("/")[1]
+
+        if service_name == "drop"
+          instance_eval(<<-EOS)
+            def #{service_name}(flowId)
+              #{service}.new flowId, connection, get_options
+            end
+          EOS
+        else
+          instance_eval(<<-EOS)
+            def #{service_name}
+              #{service}.new connection, get_options
+            end
+          EOS
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/flowthings/configuration.rb

@@ -0,0 +1,39 @@
+module Flowthings
+  module Configuration
+    VALID_OPTIONS_KEYS    = [:account_name, :account_token].freeze
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent, :secure, :platform_version]
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_ENDPOINT    = "api.flowthings.io"
+    DEFAULT_USER_AGENT  = "Flowthings API Ruby Gem #{Flowthings::VERSION}".freeze
+
+    DEFAULT_ACCOUNT_TOKEN         = nil
+    DEFAULT_ACCOUNT_NAME          = nil
+    DEFAULT_SECURE                = true
+    DEFAULT_PLATFORM_VERSION      = 'v0.1'
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.endpoint = DEFAULT_ENDPOINT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.secure = DEFAULT_SECURE
+      self.platform_version = DEFAULT_PLATFORM_VERSION
+
+      self.account_token = DEFAULT_ACCOUNT_TOKEN
+      self.account_name = DEFAULT_ACCOUNT_NAME
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten]
+    end
+  end
+end

data/lib/flowthings/connection.rb

@@ -0,0 +1,23 @@
+require 'excon'
+require 'active_support/notifications'
+require 'flowthings/error'
+
+module Flowthings
+  module Connection
+
+    private
+    def connection
+      url = @endpoint
+      if @secure
+        url = "https://" + url
+      else
+        url = "http://" + url
+      end
+
+      @connection = Excon.new(url,
+                              headers: {"X-Auth-Token" => @account_token,
+                                        "Content-Type" => "application/json"})
+    end
+
+  end
+end

data/lib/flowthings/crud/aggregate.rb

@@ -0,0 +1,18 @@
+require 'flowthings/utils/crud_utils'
+
+module Flowthings
+  module Crud
+    module Aggregate
+      include Flowthings::CrudUtils
+
+      def aggregate(data, params={})
+        path = mk_path({tail: "aggregate"})
+        params = mk_params(params)
+        data = mk_data(data)
+
+        platform_post(path, params=params, data=data)
+      end
+
+    end
+  end
+end