vworkapp_ruby 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in vworkapp.gemspec
+gemspec

data/README.md

@@ -0,0 +1,15 @@
+# vWorkApp
+
+This is a wrapper around vWorkApp's API. Go on! Use it!
+
+    VWorkApp::Job.api_key = "MY_API_KEY"
+    jobs = VWorkApp::Job.find(:worker_id => 1971, :state => "not_started")
+
+## Todo
+
+- Handle paging
+
+- Broken API bits:
+    * What's find(:search) for??. 
+    * customer_name broken? 
+    * Why can't I filter by template? 

data/examples/create_job.rb

@@ -0,0 +1,34 @@
+# -------------
+# Example: Create job
+# -------------
+# Imports a list of jobs from Google Docs and creates them in vWorkApp
+# 
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib') unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib')
+require "rubygems"
+require "vworkapp_ruby"
+
+MIN = 60
+HOUR = 60 * MIN
+
+VWorkApp.api_key = "AtuogECLCV2R7uT-fkPg"
+
+puts <<-EOL
+----------------------------
+  vWorkApp - Create Job
+----------------------------
+EOL
+
+job = VWorkApp::Job.new(
+  "ACME Inc.", 
+  "Standard Booking",
+  10 * HOUR,
+  [
+    VWorkApp::Step.new("End", VWorkApp::Location.from_address("201 1st Street, SF", :us)),
+    VWorkApp::Step.new("Start", VWorkApp::Location.new("880 Harrison St!", 37.779536, -122.401503))
+  ],
+  [
+    VWorkApp::CustomField.new("Note", "Hi There!"),
+  ]
+)
+p job.create

data/examples/print_jobs.rb

@@ -0,0 +1,34 @@
+# -------------
+# Example: Print Jobs
+# -------------
+# Gets all workers, and then prints a list of each's unstarted jobs to the terminal.
+# 
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib') unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib')
+require "rubygems"
+require "vworkapp_ruby"
+
+VWorkApp.api_key = "AtuogECLCV2R7uT-fkPg"
+
+# MultiXml.parser = :rexml
+# p MultiXml.parser
+
+puts <<-EOL
+----------------------------
+  vWorkApp - List of jobs
+----------------------------
+EOL
+workers = VWorkApp::Worker.all
+
+workers.each do |worker|
+  puts "Worker: #{worker.name}"
+  jobs = VWorkApp::Job.find(:worker_id => worker.id, :state => "not_started")
+  jobs.each do |job|
+    puts "\t #{job.third_party_id || job.id}, #{job.customer_name}, #{job.template_name}"
+  end
+  puts ""
+end
+
+# p jobs = VWorkApp::Job.find(:worker_id => 4228)["cars"]
+
+# p job = VWorkApp::Job.show(180022)

data/lib/vworkapp_ruby.rb

@@ -0,0 +1,8 @@
+require 'vworkapp_ruby/base'
+require 'vworkapp_ruby/job'
+require 'vworkapp_ruby/worker'
+require 'vworkapp_ruby/customer'
+require 'vworkapp_ruby/response_error'
+# require 'vworkapp/proof_of_delivery'
+
+require 'vworkapp_ruby/httparty_monkey_patch'

data/lib/vworkapp_ruby/base.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+
+module VWorkApp
+  
+  class << self
+    @api_key = "YOU NEED TO SPECIFY YOUR API KEY!!"
+
+    def api_key=(key)
+      @api_key = key
+    end
+    def api_key
+      @api_key
+    end
+  end
+      
+  class Base
+
+    include HTTParty
+
+    base_uri 'api.vworkapp.com/api/2.0'
+    # http_proxy 'localhost', 8888
+    # format :xml
+
+    headers({
+      "User-Agent" => "Ruby.vWorkApp.API"
+    })
+
+    # Examines a bad response and raises an approriate exception
+    #
+    # @param [HTTParty::Response] response
+    def self.bad_response(response)
+      if response.class == HTTParty::Response
+        raise ResponseError, response
+      end
+      raise StandardError, "Unkown error"
+    end
+
+  end
+
+end

data/lib/vworkapp_ruby/cli/job.rb

@@ -0,0 +1,5 @@
+vwk-job find -w 12 -c Bob
+vwk-job show -w 12 -c Bob
+vwk-job create -worker 12 --customer Bob --template Delivery --start-time --duration 12 --cf name1:value1,name1:value1
+vwk-job list -w 12 -c Bob
+vwk-job delete -w 12 -c Bob

data/lib/vworkapp_ruby/httparty_monkey_patch.rb

@@ -0,0 +1,67 @@
+
+## 
+# Needed because the extra attributes on the below XML cause httparty to crash: 
+#   <jobs type="array" current_page="1" per_page="27" total_pages="1" total_entries="27">
+# 
+# We probably shouldn't have extra parameters here.
+# 
+#   && v.is_a?(Array)
+
+module MultiXml
+
+  def MultiXml.typecast_xml_value(value)
+    case value
+    when Hash
+      if value['type'] == 'array'
+        _, entries = value.detect { |k, v| k != 'type' && (v.is_a?(Array) || v.is_a?(Hash)) }
+
+        if entries.nil? || (entries.is_a?(String) && entries.strip.empty?)
+          []
+        else
+          case entries
+          when Array
+            entries.map {|entry| typecast_xml_value(entry)}
+          when Hash
+            [typecast_xml_value(entries)]
+          else
+            raise "can't typecast #{entries.class.name}: #{entries.inspect}"
+          end
+        end
+      elsif value.has_key?(CONTENT_ROOT)
+        content = value[CONTENT_ROOT]
+        if block = PARSING[value['type']]
+          block.arity == 1 ? block.call(content) : block.call(content, value)
+        else
+          content
+        end
+      elsif value['type'] == 'string' && value['nil'] != 'true'
+        ''
+      # blank or nil parsed values are represented by nil
+      elsif value.empty? || value['nil'] == 'true'
+        nil
+      # If the type is the only element which makes it then
+      # this still makes the value nil, except if type is
+      # a XML node(where type['value'] is a Hash)
+      elsif value['type'] && value.size == 1 && !value['type'].is_a?(Hash)
+        nil
+      else
+        xml_value = value.inject({}) do |hash, (k, v)|
+          hash[k] = typecast_xml_value(v)
+          hash
+        end
+
+        # Turn {:files => {:file => #<StringIO>} into {:files => #<StringIO>} so it is compatible with
+        # how multipart uploaded files from HTML appear
+        xml_value['file'].is_a?(StringIO) ? xml_value['file'] : xml_value
+      end
+    when Array
+      value.map!{|i| typecast_xml_value(i)}
+      value.length > 1 ? value : value.first
+    when String
+      value
+    else
+      raise "can't typecast #{value.class.name}: #{value.inspect}"
+    end
+  end
+
+end

data/lib/vworkapp_ruby/job.rb

@@ -0,0 +1,162 @@
+require 'gcoder'
+
+module VWorkApp
+
+  class Location
+    attr_accessor :formatted_address, :lat, :lng
+    def initialize(formatted_address, lat, lng)
+      @formatted_address = formatted_address
+      @lat = lat
+      @lng = lng
+    end
+    
+    def self.from_address(address, region = :us)
+      loc = Location.geocode(address, region).first.geometry.location
+      self.new(address, loc.lat, loc.lng)
+    end
+    
+    def to_hash
+      { :formatted_address => formatted_address, :lat => lat, :lng => lng }
+    end
+    
+    def self.from_hash(attributes)
+      return nil unless attributes
+      Location.new(attributes["formatted_address"], attributes["lat"], attributes["lng"])
+    end
+    
+  private
+
+    def self.geocode(address, region)
+      @gecoder ||= GCoder.connect(:storage => :heap)
+      @gecoder[address, { :region => region }]
+    end
+
+  end
+
+  class Step
+    attr_accessor :name, :location
+    def initialize(name, location = nil)
+      @name = name
+      @location = location
+    end
+
+    def to_hash
+      h = { :name => name }
+      h.merge!({ :location => location.to_hash }) if location  
+      h
+    end
+    
+    def self.from_hash(attributes)
+      Step.new(attributes["name"], Location.from_hash(attributes["location"]))
+    end
+    
+  end
+
+  class CustomField
+    attr_accessor :name, :value
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+
+    def to_hash
+      { :name => name.to_s, :value => value.to_s }
+    end
+    
+    def self.from_hash(attributes)
+      CustomField.new(attributes["name"], attributes["value"])
+    end
+    
+  end
+
+  class Job < Base
+    
+    attr_accessor :id, :customer_name, :template_name, :planned_duration, :steps, :custom_fields, :third_party_id, :assigned_to, :planned_start_at
+
+    ##
+    # Creates a new jobs in vWorkApp.
+    # 
+    # Steps and Custom_Fields takes an array of these.
+    # 
+    def initialize(customer_name, template_name, planned_duration, steps, custom_fields = nil, id = nil, third_party_id = nil, assigned_to = nil, planned_start_at = nil)
+      @id = id
+      @customer_name = customer_name
+      @template_name = template_name 
+      @planned_duration = planned_duration 
+      @steps = steps
+      @custom_fields = custom_fields 
+      @third_party_id = third_party_id
+      @assigned_to = assigned_to
+      @planned_start_at = planned_start_at
+    end
+        
+    def is_new?
+      self.id == nil
+    end
+    
+    def to_hash
+      job_hash = {
+        :job => {
+          :customer_name => self.customer_name,
+          :template_name  => self.template_name,
+          :planned_duration => self.planned_duration,
+          :steps =>  self.steps.map { |s| s.to_hash },
+        }
+      }
+      job_hash[:job][:third_party_id] = self.third_party_id if third_party_id
+      job_hash[:job][:custom_fields] = self.custom_fields.map { |s| s.to_hash } if custom_fields
+      job_hash
+    end
+
+    def self.from_hash(attributes)
+      j = Job.new(attributes["customer_name"], attributes["template_name"], attributes["planned_duration"], attributes["steps"].map { |h| Step.from_hash(h) }, nil, attributes["id"], attributes["third_party_id"])
+      j.custom_fields = attributes["custom_fields"].map { |h| CustomField.from_hash(h) } if attributes["custom_fields"]
+      j
+    end
+    
+    def create
+      res = self.class.post("/jobs", :body => self.to_hash, :query => { :api_key => VWorkApp.api_key })
+      res.success? ? res : self.class.bad_response(res)
+    end
+
+    def update(id, attributes)
+      res = self.class.post("/jobs", :body => { :job => self.to_hash }, :query => { :api_key => VWorkApp.api_key })
+      res.success? ? res : bad_response(res)
+    end
+
+    def self.all
+      find
+    end
+
+    ##
+    # Returns jobs that match the given query options. Valid options are:
+    #   - :state — Filter by state. Possible values: unallocated, allocated, assigned, not_started, started, completed.
+    #   - :start_at — Filter by planned_start_at/last_action_time (must also give end_at).
+    #   - :end_at — Filter by planned_start_at/last_action_time (must also give start_at).
+    #   - :customer_name — Filter by customer name.
+    #   - :worker_id — Filter by assigned worker.
+    #   - :worker_third_party_id — Filter by assigned worker third party id.
+    #   - :per_page — The number of records to return per page.
+    #   - :page — The page of records to return.
+    #   - :third_party_id — The third_party_id associated with the job.
+    def self.find(options={})
+      p options
+      third_party_id = options.delete(:third_party_id)
+      options[:search] = "@third_party_id=#{third_party_id}" if (third_party_id)
+      options[:api_key] = VWorkApp.api_key
+      
+      raw = get("/jobs.xml", :query => options)
+      raw["jobs"].map { |h| Job.from_hash(h) }
+    end
+
+    def self.show(id)
+      get("/jobs/#{id}.xml", :query => { :api_key => VWorkApp.api_key })
+    end
+    
+    def self.delete(id)
+      
+    end
+        
+  end
+
+end

data/lib/vworkapp_ruby/response_error.rb

@@ -0,0 +1,35 @@
+module VWorkApp
+  
+  # Error raised on a bad response
+  class ResponseError < StandardError
+    
+    attr_reader :response, :code, :errors
+    
+    def initialize(res)
+      @response = res.response
+      @code     = res.code
+      @errors   = parse_errors(res.parsed_response)
+    end
+    
+    def to_s
+      p @response.body
+      "#{code.to_s} #{response.msg}".strip
+    end
+    
+    private
+    
+    def parse_errors(errors)
+      return case errors
+        when Hash
+           errors.collect{|k,v| "#{k}: #{v}"}
+        when String
+           [errors]
+        when Array
+           errors
+        else []
+      end
+    end
+    
+  end
+  
+end

data/lib/vworkapp_ruby/worker.rb

@@ -0,0 +1,51 @@
+module VWorkApp
+
+  class Telemetry
+    attr_accessor :lat, :lng, :recorded_at, :heading, :speed
+    def initialize (lat, lng, recorded_at, heading, speed)
+      @lat = lat
+      @lng = lng
+      @recorded_at = recorded_at
+      @heading = heading
+      @speed = speed
+    end
+    
+    def self.from_hash(attributes)
+      @lat = attributes["lat"]
+      @lng = attributes["lng"]
+      @recorded_at = attributes["recorded_at"]
+      @heading = attributes["heading"]
+      @speed = attributes["speed"]
+    end
+    
+  end
+
+  class Worker < Base
+    
+    attr_accessor :id, :name, :email, :latest_telemetry, :third_party_id
+    
+    def initialize(name, email, id = nil, third_party_id = nil)
+      @name = name
+      @email = email
+      @id = id
+      @third_party_id = third_party_id
+    end
+    
+    def self.all
+      find
+    end
+
+    def self.find
+      raw = get("/workers.xml", :query => { :api_key => VWorkApp.api_key })["workers"]
+      raw.map { |h| Worker.from_hash(h) }
+    end
+    
+    def self.from_hash(attributes)
+      w = Worker.new(attributes["name"], attributes["email"], attributes["id"], attributes["third_party_id"])
+      w.latest_telemetry = Telemetry.from_hash(attributes["latest_telemetry"]) if attributes["latest_telemetry"]
+      w
+    end
+    
+  end
+
+end

data/vworkapp_ruby.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = "vworkapp_ruby"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["vWorkApp Inc.", "Aish Fenton"]
+  s.email       = ["info@vworkapp.com"]
+  s.homepage    = "http://api.vworkapp.com/api/"
+  s.summary     = %q{Simple interface to vWorkApp's api}
+  s.description = %q{Simple interface to vWorkApp's api}
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_dependency "httparty"
+  s.add_dependency "gcoder"
+  s.add_development_dependency "rspec"
+
+  s.files              = `git ls-files`.split("\n") rescue ''
+  s.test_files         = `git ls-files -- {test, spec, features}/*`.split("\n")
+
+  s.require_paths      = ["lib"]
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: vworkapp_ruby
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- vWorkApp Inc.
+- Aish Fenton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gcoder
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Simple interface to vWorkApp's api
+email: 
+- info@vworkapp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.md
+- examples/create_job.rb
+- examples/print_jobs.rb
+- lib/vworkapp_ruby.rb
+- lib/vworkapp_ruby/base.rb
+- lib/vworkapp_ruby/cli/job.rb
+- lib/vworkapp_ruby/customer.rb
+- lib/vworkapp_ruby/httparty_monkey_patch.rb
+- lib/vworkapp_ruby/job.rb
+- lib/vworkapp_ruby/response_error.rb
+- lib/vworkapp_ruby/worker.rb
+- vworkapp_ruby.gemspec
+homepage: http://api.vworkapp.com/api/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple interface to vWorkApp's api
+test_files: []
+