task_master 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da7cd729be877ce97825e77e71389dfdf6d0df90
+  data.tar.gz: ca5690c820c86bf15a20e32a400dd8b4828d1320
+SHA512:
+  metadata.gz: 0483e83a826ce9aebd09392310ddf5f10529aef91844efca23cd6119597cadb9d9b8bf7205fbc0a590a27e35eb974cf865f84f24ae6e8a1bde4fd6c975898b3b
+  data.tar.gz: 189f1f83001d85fb69e57e345f273d27a4ccd34c47b27903c7304f6ec0fea40a47259efaeaad3276d563acb4739d3c2a2cb637742b913e41a77ece1dbaad2ff0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Sean Devine
+
+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/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TaskMaster'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/task_master/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/task_master/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/task_master/application_controller.rb

@@ -0,0 +1,4 @@
+module TaskMaster
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/task_master/webhook_controller.rb

@@ -0,0 +1,32 @@
+module TaskMaster
+  class WebhookController < ApplicationController
+
+    def create
+      response = JSON.parse(request.body.read)
+
+      request_instance = nil
+
+      if response["key"].nil?
+        head :bad_request and return
+      end
+
+      # Fancy Hands uses a single URL for all webhooks.
+      # We need to iterate through the request classes to find one
+      # that has the key from the response.
+      [CustomRequest].each do |request_class|
+        break if request_instance = request_class.find_by(key: response["key"])
+      end
+
+      if request_instance
+        request_instance.responses << response
+        request_instance.save!
+      end
+
+      head :ok
+
+    rescue JSON::ParserError
+      head :bad_request
+    end
+
+  end
+end

data/app/helpers/task_master/application_helper.rb

@@ -0,0 +1,4 @@
+module TaskMaster
+  module ApplicationHelper
+  end
+end

data/app/models/task_master/client.rb

@@ -0,0 +1,34 @@
+require "fancyhands"
+
+module TaskMaster
+  class Client
+    extend Forwardable
+    def_delegators :@client, :request
+
+    def initialize(key = TaskMaster.key, secret = TaskMaster.secret)
+      unless key.present? && secret.present?
+        raise ArgumentError, "Credentials are not configured. Set TaskMaster.key and TaskMaster.secret with your Fancy Hands credentials."
+      end
+      @client = FancyHands::V1::Client.new(key, secret)
+    end
+
+    def ping
+      request.get("echo", {}) == {}
+    end
+
+    def create_custom_request(data)
+      request.post("request/custom", data)
+    end
+
+    def cancel_custom_request(key)
+      response = request.post("request/custom/cancel", { key: key })
+      response["status"] == true
+    end
+
+    def trigger_callback(key)
+      response = request.post("callback", { key: key })
+      response["status"] == "ok"
+    end
+
+  end
+end

data/app/models/task_master/custom_request.rb

@@ -0,0 +1,177 @@
+module TaskMaster
+  class CustomRequest < ActiveRecord::Base
+    STATUSES = {
+      1 => "NEW",
+      5 => "OPEN",
+      7 => "AWAITING_RESPONSE",
+      20 => "CLOSED",
+      21 => "EXPIRED"
+    }
+
+    serialize :custom_fields, JSON
+
+    serialize :responses, JSON
+
+    serialize :answers, JSON
+
+    serialize :messages, JSON
+
+    serialize :phone_calls, JSON
+
+    belongs_to :requestor, polymorphic: true
+
+    after_initialize :_initialize_custom_fields
+
+    validates :description, presence: true
+
+    validates :numeric_status, inclusion: { in: STATUSES.keys }, allow_nil: true
+
+    validate :_custom_fields_is_not_empty
+
+    validate :_custom_fields_are_all_valid
+
+    before_save :_set_attributes_from_last_response
+
+    before_save :_set_closed_without_answers
+
+    after_commit :post_to_fancyhands, on: [:create]
+
+    # Override this method if you'd like to move the post to Fancy Hands
+    # into the background. Redefine #post_to_fancyhands to queue the job
+    # in whatever other way you'd prefer.
+    def post_to_fancyhands
+      post_to_fancyhands_now
+    end
+
+    def post_to_fancyhands_now
+      return if key.present?
+
+      response = Client.new.create_custom_request(_to_fancy_hands_data)
+      self.responses << response
+      save
+    end
+
+    def cancel
+      return false unless key.present?
+
+      Client.new.cancel_custom_request(key)
+    end
+
+    def trigger_callback
+      return false unless key.present?
+
+      Client.new.trigger_callback(key)
+    end
+
+    def status
+      return unless numeric_status.present?
+
+      STATUSES[numeric_status]
+    end
+
+    def _set_attributes_from_last_response
+      sorted_responses = []
+      # add the responses that don't have date_updated present to the beginning
+      # sorted responses
+
+      sorted_responses += responses.select do |response|
+        response["date_updated"].blank?
+      end
+
+      sorted_responses += responses.select do |response|
+        response["date_updated"].present?
+      end.sort_by do |response|
+        DateTime.parse(response["date_updated"])
+      end
+
+      self.responses = sorted_responses
+
+      return unless last_response = responses.last
+
+      if key.blank?
+        raise StandardError, "The last response had a blank key. #{last_response.inspect}" if last_response["key"].blank?
+        self.key = last_response["key"]
+      end
+
+      if last_response["numeric_status"].present?
+        self.numeric_status = Integer(last_response["numeric_status"])
+      end
+
+      if last_response["date_created"].present? && !fancyhands_created_at.present?
+        self.fancyhands_created_at = DateTime.parse(last_response["date_created"])
+      end
+
+      if last_response["date_updated"].present?
+        self.fancyhands_updated_at = DateTime.parse(last_response["date_updated"])
+      end
+
+      if self.numeric_status == 20
+        self.fancyhands_closed_at = fancyhands_updated_at
+      end
+
+      self.answers ||= {}
+
+      Array(last_response["custom_fields"]).each do |custom_field|
+        self.answers[custom_field["field_name"]] = custom_field["answer"]
+      end
+
+      self.messages = Array(last_response["messages"])
+
+      self.phone_calls = Array(last_response["phone_calls"])
+
+      Array(last_response["phone_calls"]).each do |phone_call|
+        self.phone_call_seconds += Integer(phone_call["duration"])
+      end
+
+      return true
+    end
+
+    def _set_closed_without_answers
+      return unless numeric_status == 20
+
+      self.closed_without_answers = answers.values.all?(&:blank?)
+
+      # don't stop the save process
+      return true
+    end
+
+    def _initialize_custom_fields
+      self.custom_fields ||= []
+    end
+
+    def _custom_fields_is_not_empty
+      if custom_fields.empty?
+        errors.add :custom_fields, "can't be empty"
+      end
+    end
+
+    def _custom_fields_are_all_valid
+      messages = {}
+      custom_fields.map do |f|
+        CustomRequestField.new(f.to_hash)
+      end.each_with_index do |field, index|
+        next if field.valid?
+        messages[index] = field.errors.full_messages
+      end
+      if messages.any?
+        errors.add(
+          :custom_fields,
+          messages.map do |index, full_messages|
+            "custom field at index #{index} has errors #{full_messages.join(", ")}."
+          end.join(", ")
+        )
+      end
+    end
+
+    def _to_fancy_hands_data
+      {
+        title: title,
+        description: description,
+        bid: bid.to_f,
+        expiration_date: expiration_date.strftime("%Y-%m-%dT%H:%M:%SZ"),
+        custom_fields: custom_fields.map(&:to_hash).to_json
+      }
+    end
+
+  end
+end

data/app/models/task_master/custom_request_field.rb

@@ -0,0 +1,63 @@
+module TaskMaster
+  class CustomRequestField
+    include ActiveModel::Model
+
+    DEFAULT_ATTRIBUTES = { required: false }
+
+    VALID_TYPES = %w(text textarea tel number email money date datetime-local bool checkbox radio)
+
+    TYPES_WITH_OPTIONS = %w(checkbox radio)
+
+    attr_accessor :type, :label, :description, :field_name, :required, :order, :options
+
+    def initialize(attributes = {})
+      attributes = attributes.reverse_merge(DEFAULT_ATTRIBUTES)
+      super(attributes)
+    end
+
+    validates :type, inclusion: { in: VALID_TYPES }
+
+    [:label, :description, :field_name].each do |attribute|
+      validates attribute, presence: true
+    end
+
+    validates :order, numericality: { greater_than: 0 }
+
+    validates :label, length: { maximum: 30 }
+
+    validates :description, length: { maximum: 300 }
+
+    validates :field_name, length: { maximum: 30 }
+
+    with_options if: -> { TYPES_WITH_OPTIONS.include?(type) } do
+      validate do |custom_request_field|
+        if Array(options).length < 1
+          errors.add :options, "must not be empty"
+        end
+      end
+    end
+
+    def _initialize_required
+      self.required = false if self.required.nil?
+    end
+
+    def order
+      @order.to_s
+    end
+
+    def to_hash
+      hash = {
+        type: type,
+        label: label,
+        description: description,
+        field_name: field_name,
+        required: required,
+        order: order
+      }
+      if TYPES_WITH_OPTIONS.include?(type)
+        hash[:options] = options
+      end
+      hash
+    end
+  end
+end

data/app/views/layouts/task_master/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TaskMaster</title>
+  <%= stylesheet_link_tag    "fancyengine/application", media: "all" %>
+  <%= javascript_include_tag "fancyengine/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+TaskMaster::Engine.routes.draw do
+  post "webhook", to: "webhook#create"
+end

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = "spec/test_app"

data/db/migrate/20150731173757_create_task_master_custom_requests.rb

@@ -0,0 +1,26 @@
+class CreateTaskMasterCustomRequests < ActiveRecord::Migration
+  def change
+    create_table :task_master_custom_requests do |t|
+      t.string :title
+      t.text :description, null: false
+      t.text :custom_fields, null: false
+      t.decimal :bid, null: false
+      t.datetime :expiration_date, null: false
+      t.string :key
+      t.text :responses, default: "[]"
+      t.integer :numeric_status
+      t.datetime :fancyhands_created_at
+      t.datetime :fancyhands_updated_at
+      t.datetime :fancyhands_closed_at
+      t.text :answers, default: "{}"
+      t.reference :requestor, polymorphic: true
+      t.text :messages, :text, default: "[]"
+      t.text :phone_calls, :text, default: "[]"
+      t.boolean :closed_without_answers, default: false
+      t.integer :phone_call_seconds, :integer, default: 0
+
+      t.timestamps null: false
+    end
+    add_index :task_master_custom_requests, [:requestor_id, :requestor_type], name: "idx_fcr_ri_rt"
+  end
+end

data/lib/task_master.rb

@@ -0,0 +1,6 @@
+require "task_master/engine"
+
+module TaskMaster
+  mattr_accessor :key
+  mattr_accessor :secret
+end

data/lib/task_master/engine.rb

@@ -0,0 +1,10 @@
+module TaskMaster
+  class Engine < ::Rails::Engine
+    isolate_namespace TaskMaster
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+    end
+  end
+end

data/lib/task_master/version.rb

@@ -0,0 +1,3 @@
+module TaskMaster
+  VERSION = "0.0.2"
+end

data/lib/tasks/task_master_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :task_master do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: task_master
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sean Devine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: task_master-fancyhands-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: spring
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: test_after_commit
+  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'
+description: A Rails engine that makes it easy to outsource manual tasks using the
+  Fancy Hands API.
+email:
+- barelyknown@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/task_master/application.js
+- app/assets/stylesheets/task_master/application.css
+- app/controllers/task_master/application_controller.rb
+- app/controllers/task_master/webhook_controller.rb
+- app/helpers/task_master/application_helper.rb
+- app/models/task_master/client.rb
+- app/models/task_master/custom_request.rb
+- app/models/task_master/custom_request_field.rb
+- app/views/layouts/task_master/application.html.erb
+- config/routes.rb
+- config/spring.rb
+- db/migrate/20150731173757_create_task_master_custom_requests.rb
+- lib/task_master.rb
+- lib/task_master/engine.rb
+- lib/task_master/version.rb
+- lib/tasks/task_master_tasks.rake
+homepage: http://www.github.com/togglepro/task_master
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Rails engine that makes it easy to outsource manual tasks using the Fancy
+  Hands API.
+test_files: []