bumbleworks-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0f86f86051a2e621368a53a5c74af63db5a3154
+  data.tar.gz: 1fff121f914e737a55b21858229d2515006897a3
+SHA512:
+  metadata.gz: d814b339c6da019a9f9186420d0e4936518056f5bbdd987e5cda210ef4f024a8970e8652c0e3006ba968b38e5ad748208d48e430bbefa7c8012cc11277726108
+  data.tar.gz: 7ae23252e73232a10f13667fe6bb6fe2122041c7cf9dd91afc8d1529da2d9f4da36d85f5c565b4c4c009f59138106a636459aabb02aed4352f50aeb0965be1f8

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+pkg
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Bumbleworks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+# Bumbleworks::Api
+
+A rack-based web API (using [Rory](http://github.com/screamingmuse/rory)) for your [Bumbleworks](http://github.com/bumbleworks/bumbleworks) instance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bumbleworks-api'
+
+## Usage
+
+There are quite a few ways to use this - the most common, if you're using Bumbleworks in a Rails app, would probably be to mount Bumbleworks::Api::Application at some path in your Rails routing - see the [Rails routing guide](http://guides.rubyonrails.org/routing.html#routing-to-rack-applications) for more info.
+
+Or you can run it standalone using a Rack server - basically, Bumbleworks just needs to be configured, and then you can `run Bumbleworks::Api::Application`.
+
+Note that you can also use [bumbleworks-gui](http://github.com/bumbleworks/bumbleworks-gui), which wraps this API in a simple GUI.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]
+
+Rake::TaskManager.record_task_metadata = true

data/bumbleworks-api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bumbleworks/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bumbleworks-api"
+  spec.version       = Bumbleworks::Api::VERSION
+  spec.authors       = ["Ravi Gadad"]
+  spec.email         = ["ravi@renewfund.com"]
+  spec.description   = %q{Bumbleworks JSON API}
+  spec.summary       = %q{This gem implements a headless Rory application (mountable in your own app)
+                          for interacting with a Bumbleworks instance.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "bumbleworks", ">= 0.0.91"
+  spec.add_runtime_dependency "rory", ">= 0.5.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'shotgun'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry'
+end

data/config.ru

@@ -0,0 +1,13 @@
+require_relative 'playground_setup'
+
+if ENV['MOUNT_AT']
+  app = Rack::Builder.new do
+    map ENV['MOUNT_AT'] do
+      run Bumbleworks::Api::Application
+    end
+  end
+  run app
+else
+  run Bumbleworks::Api::Application
+end
+

data/lib/bumbleworks/api.rb

@@ -0,0 +1,15 @@
+require "rory"
+require "rack"
+require "bumbleworks"
+require "json"
+require_relative "api/version"
+require_relative "api/controllers/application_controller"
+
+Rufus::Json.detect_backend
+
+module Bumbleworks
+  module Api
+  end
+end
+
+require_relative "api/config/application"

data/lib/bumbleworks/api/config/application.rb

@@ -0,0 +1,10 @@
+module Bumbleworks
+  module Api
+    class Application < Rory::Application
+    end
+  end
+end
+
+Bumbleworks::Api::Application.root = File.expand_path('..', File.dirname(__FILE__))
+Bumbleworks::Api::Application.auto_require_paths << 'lib'
+Bumbleworks::Api::Application.require_all_files

data/lib/bumbleworks/api/config/routes.rb

@@ -0,0 +1,34 @@
+Bumbleworks::Api::Application.set_routes do
+  scope :module => 'bumbleworks/api' do
+    match '/entities', :to => 'entities#types', :methods => [:get]
+    match '/entities/:type', :to => 'entities#index', :methods => [:get]
+    match '/entities/:type/:id', :to => 'entities#show', :methods => [:get]
+
+    match '/processes', :to => 'processes#index', :methods => [:get]
+    match '/processes/:id', :to => 'processes#show', :methods => [:get]
+
+    match '/tasks', :to => 'tasks#index', :methods => [:get]
+    match '/tasks/:id', :to => 'tasks#show', :methods => [:get]
+
+    match '/tasks/:id/claim', :to => 'tasks#claim', :methods => [:put]
+    match '/tasks/:id/release', :to => 'tasks#release', :methods => [:put]
+    match '/tasks/:id/complete', :to => 'tasks#complete', :methods => [:put]
+
+    match '/trackers', :to => 'trackers#index', :methods => [:get]
+    match '/trackers/:id', :to => 'trackers#show', :methods => [:get]
+
+    match '/errors', :to => 'errors#index', :methods => [:get]
+    match '/processes/:pid/expressions/:id/error', :to => 'errors#show', :methods => [:get]
+    match '/processes/:pid/expressions/:id/error/replay', :to => 'errors#replay', :methods => [:put]
+
+    match '/processes/:pid/expressions/:id', :to => 'expressions#show', :methods => [:get]
+    match '/processes/:pid/expressions/:id/cancel', :to => 'expressions#cancel', :methods => [:delete]
+    match '/processes/:pid/expressions/:id/kill', :to => 'expressions#kill', :methods => [:delete]
+
+    match '/workers', :to => 'workers#index', :methods => [:get]
+    match '/workers/prune', :to => 'workers#prune_stale_worker_info', :methods => [:delete]
+    match '/workers/command/:command', :to => 'workers#change_global_state', :methods => [:put]
+    match '/workers/:id', :to => 'workers#show', :methods => [:get]
+    match '/workers/:id/command/:command', :to => 'workers#change_state', :methods => [:put]
+  end
+end

data/lib/bumbleworks/api/controllers/application_controller.rb

@@ -0,0 +1,6 @@
+module Bumbleworks
+  module Api
+    class ApplicationController < Rory::Controller
+    end
+  end
+end

data/lib/bumbleworks/api/controllers/entities_controller.rb

@@ -0,0 +1,25 @@
+module Bumbleworks
+  module Api
+    class EntitiesController < ApplicationController
+      def types
+        render :json => EntityClassPresenter.present(Bumbleworks.entity_classes)
+      end
+
+      def index
+        render :json => EntityPresenter.present(entity_class.all)
+      end
+
+      def show
+        entity = entity_class.first_by_identifier(params[:id])
+        render :json => EntityPresenter.present(entity)
+      end
+
+    private
+
+      def entity_class
+        class_name = Bumbleworks::Support.camelize(params[:type])
+        entity_class = Bumbleworks::Support.constantize(class_name)
+      end
+    end
+  end
+end

data/lib/bumbleworks/api/controllers/errors_controller.rb

@@ -0,0 +1,32 @@
+module Bumbleworks
+  module Api
+    class ErrorsController < ApplicationController
+      def index
+        render :json => Bumbleworks::Api::ErrorPresenter.present(Bumbleworks.errors)
+      end
+
+      def show
+        render :json => Bumbleworks::Api::ErrorPresenter.present(error)
+      end
+
+      def replay
+        error.replay
+        render :json => { :status => 'replayed' }
+      end
+
+    private
+
+      def expression
+        process.expression_at_position(params[:id])
+      end
+
+      def error
+        expression.error
+      end
+
+      def process
+        Bumbleworks::Process.new(params[:pid])
+      end
+    end
+  end
+end

data/lib/bumbleworks/api/controllers/expressions_controller.rb

@@ -0,0 +1,29 @@
+module Bumbleworks
+  module Api
+    class ExpressionsController < ApplicationController
+      def show
+        render :json => Bumbleworks::Api::ExpressionPresenter.present(expression)
+      end
+
+      def cancel
+        expression.cancel!
+        render :json => { "status" => "cancelled" }
+      end
+
+      def kill
+        expression.kill!
+        render :json => { "status" => "killed" }
+      end
+
+    private
+
+      def expression
+        process.expression_at_position(params[:id])
+      end
+
+      def process
+        Bumbleworks::Process.new(params[:pid])
+      end
+    end
+  end
+end

data/lib/bumbleworks/api/controllers/processes_controller.rb

@@ -0,0 +1,29 @@
+module Bumbleworks
+  module Api
+    class ProcessesController < ApplicationController
+      def index
+        processes = Bumbleworks::Process.all(:limit => limit, :offset => offset)
+        render :json => Bumbleworks::Api::ProcessPresenter.present(processes)
+      end
+
+      def show
+        process = Bumbleworks::Process.new(params[:id])
+        render :json => Bumbleworks::Api::ProcessPresenter.present(process)
+      end
+
+    private
+
+      def page
+        params.fetch(:page) { 1 }.to_i
+      end
+
+      def limit
+        params.fetch(:limit) { 10 }.to_i
+      end
+
+      def offset
+        (page - 1) * limit
+      end
+    end
+  end
+end

data/lib/bumbleworks/api/controllers/tasks_controller.rb

@@ -0,0 +1,43 @@
+module Bumbleworks
+  module Api
+    class TasksController < ApplicationController
+      def index
+        render :json => Bumbleworks::Api::TaskPresenter.present(Bumbleworks::Task.all)
+      end
+
+      def show
+        render :json => Bumbleworks::Api::TaskPresenter.present(task)
+      end
+
+      def claim
+        task.claim(params[:claimant])
+        render :json => Bumbleworks::Api::TaskPresenter.present(task)
+      end
+
+      def release
+        task.release
+        render :json => Bumbleworks::Api::TaskPresenter.present(task)
+      end
+
+      def complete
+        task.complete(params_without_id)
+        render :json => { :status => 'completed' }
+      rescue Bumbleworks::Task::NotCompletable => e
+        render :json => {
+          :status => 'not_completable',
+          :message => e.message
+        }, :status => 422
+      end
+
+    private
+
+      def task
+        Bumbleworks::Task.find_by_id(params[:id])
+      end
+
+      def params_without_id
+        params.reject { |k,v| k.to_s == "id" }
+      end
+    end
+  end
+end

data/lib/bumbleworks/api/controllers/trackers_controller.rb

@@ -0,0 +1,13 @@
+module Bumbleworks
+  module Api
+    class TrackersController < ApplicationController
+      def index
+        render :json => Bumbleworks::Api::TrackerPresenter.present(Bumbleworks::Tracker.all)
+      end
+
+      def show
+        render :json => Bumbleworks::Api::TrackerPresenter.present(Bumbleworks::Tracker.new(params[:id]))
+      end
+    end
+  end
+end

data/lib/bumbleworks/api/controllers/workers_controller.rb

@@ -0,0 +1,51 @@
+module Bumbleworks
+  module Api
+    class WorkersController < ApplicationController
+      AllowedCommands = ["pause", "unpause", "shutdown"]
+
+      before_action :refresh_worker_info, :only => [:index, :show]
+
+      def index
+        worker_info = Bumbleworks::Worker::Info.all
+        render :json => Bumbleworks::Api::WorkerPresenter.present(worker_info)
+      end
+
+      def show
+        worker_info = Bumbleworks::Worker::Info[params[:id]]
+        render :json => Bumbleworks::Api::WorkerPresenter.present(worker_info)
+      end
+
+      def change_state
+        command = params[:command]
+        if AllowedCommands.include?(command.to_s)
+          worker_info = Bumbleworks::Worker::Info[params[:id]]
+          worker_info.send(command)
+          render :json => { "status" => "#{command} sent" }
+        else
+          render :json => { "error" => "not_found" }, :status => 404
+        end
+      end
+
+      def change_global_state
+        command = params[:command]
+        if AllowedCommands.include?(command.to_s)
+          Bumbleworks::Worker.send("#{command}_all")
+          render :json => { "status" => "#{command} sent" }
+        else
+          render :json => { "error" => "not_found" }, :status => 404
+        end
+      end
+
+      def prune_stale_worker_info
+        Bumbleworks::Worker::Info.purge_stale_worker_info
+        render :json => { "status" => "pruned_stale_worker_info" }
+      end
+
+    private
+
+      def refresh_worker_info
+        Bumbleworks::Worker.refresh_worker_info
+      end
+    end
+  end
+end